betterdo-api

The API for BetterDo. This repository houses the application logic by providing a simple REST API.

It's recommended you run this with the UI. See betterdo-ui.

Features

• 🤖 Simple usable REST API
• 🤓 Elegant application structure for easy adaption
• ✅ 100% end-to-end test coverage
• 🛤Ability to authenticate with Google (and ability to add others) 🛤
• ⌨️ Built on TypeScript
• 🎼 Leverages GitHub actions for automated production deploys and testing

Setup

1. Copy .env.sample to .env and then fill it in.

   cp .env.sample .env

2. Generate VAPID key details and fill them into .env

   npx web-push generate-vapid-keys

3. Create Google OAuth tokens (see here) and enter details into Google OAUTH .env sections.

4. Install MongoDB with brew tap mongodb/brew && brew install mongodb-community

5. Run npm install

6. Run npm start

Endpoints

• / - The landing page
• /app - The application (requires authentication)
• /auth/google - Authenticate with Google Endpoint
• /auth/google/callback - Google authentication callback
• /auth/logout - Logout endpoint
• /api/lists - Methods around updating lists
  • GET: get lists
  • PUT add list
  • POST update list
  • DELETE delete list
• /api/tasks - Methods around updating tasks
  • GET: get task
  • PUT add task
  • POST update task
  • DELETE deleteTask
• /api/users/:email - GET method for seeing if a user exists with an email
• /api/user - GET method for current user information
• /api/users - POST method for modifying current user