New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create App Skeleton documentation #9

Open

manuel12 opened this issue Feb 19, 2024 · 0 comments

Assignees

Labels

documentation enhancement

Owner

manuel12 commented Feb 19, 2024

This documentation will outline the whole app:

Should include:
Front-end:
Back-end:

Database: describe the database
Routes: describe the routes folders and sub-folders
- Users: describe user folder rourtes
  - createUser: describe route
    - Url: POST /api/user/
    - Validations: username/email/password
    - Error response: status: 400 - message: A user with email ${data.email} already exists!
    - Success response: status: 201 - message: User ${data.email} successfully registered!

The text was updated successfully, but these errors were encountered:

manuel12 self-assigned this

manuel12 added documentation enhancement labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment