travistang / in2087

For group 42

IN2087

For group 42

ATTENTION!

Anything starting from branch v3 is just for personal interest instead of credits:)

How to set up the frontend + backend (on your machine)

• install docker-compose
• in the directory (where docker-compose.yml is), run docker-compose up --build (if that doesnt work, try with sudo)
• wait for docker to finish doing its stuffs (until you see something like API is running in port 3000
• try to type localhost:1234 on your browser, then add mongodb://mongo:27017/finda, and press connect, then you should be able to see the internal structure of the Mongo.
• the frontend is running at localhost:3001
• the backend is running at localhost:3000

Endpoints

Proposed endpoint structures are as follows:

Authentication / Entity managements

• /auth
  • POST /login
  • POST /register
  • ~~[ ] POST /create_group ~~

Users

• /me

  • POST /toPremium

  • GET /info

  • POST /info

  • GET /wants

  • POST /wants

  • DELETE /wants

  • [ ] PATCH /wants

  • GET /offers

  • POST /offers

  • DELETE /offers

  • [ ] PATCH /offers

• /user/:username

  • GET /info
  • GET /wants
  • GET /offers

Debugging

• /test
  • GET /register
  • GET /populate

Groups

• GET /group
• POST /group
• /group/:groupname

  • GET /info

  • POST /info

  • GET /wants

  • POST /wants

  • DELETE /wants

  • [ ] PATCH /wants

  • GET /offers

  • POST /offers

  • DELETE /wants

  • [ ] PATCH /wants

  • GET /messages

  • POST /messages

  • POST /join

  • POST /quit

  • [ ] POST /canceljoin

  • [ ] POST /approve/:username

  • [ ] POST /reject/:username

  • [ ] POST /invite/:username

Searches

• /search
  • GET /wants?q=<search_string>
  • GET /offers?q=<search_string>
  • GET /users?q=<search_string>
  • GET /groups?q=<search_string>