What's next?

"Don't stop when you're tired. Stop when you're done."

"What's next?" aims to be a minimislitc todo app, pushing the user to constant tunnel vision - to help them strike procrastination.

Link: https://whatsnext-blond.vercel.app/

Screenshots

Setting up project

• Clone this repo
  • Server
    • Head to /server and run npm install (this ensures you have all the necesary packages)
    • To start the development server, run npm run dev - This should fire up the server 🚀
  • WebApp
    • Head to /webapp and run npm install (this ensures you have all the necesary packages)
    • To start the app, run npm run dev 🚀

API documentation

1. POST /v1/api/user/signup

Endpoint handling Signup.
Expects the following parameters:
  - Name
  - Email
  - Password 

2. POST /v1/api/user/login

Endpoint handling Login
Expects the following parameters:
  - Email
  - Password 

3. POST /v1/api/todo/

Endpoint handling Todo creation
Expects the following parameters:
  - Title
  - Description 

4. GET /v1/api/todo/

Endpoint that fetches a user's todo's 

5. PUT /v1/api/todo/

Endpoint handling Todo updation
Expects the following parameters:
  - Title
  - Description
  - Status

4. DELETE /v1/api/todo/

Endpoint handling Todo deletion
Expects the following parameters:
  - Id of record

Deployment

• The server is hosted on Railway
• The webapp is hosted on Vercel
• For both deployments, the following process was done:
  • Connect GH repo to the respsective services
  • Configure directory
  • Once that's done, any subsequent push to the respective directories would trigger re-deployment
• The database is hosted on Railway as well
  • Connecting to DB from server:
    • Create Mongo project
    • Use Set MONGO_URI in variables of server to PUBLIC_URL of DB

Design considerations

• The app is intentionally designed with simplicity in mind to minimize distractions, in hopes to allow users to focus on the core functionality, helping them complete their tasks.
• The title: "What's next?" aims to keep the user pushing, constantly asking themselves, "what's next?"