Skip to content

alebausa/backend-template-m3

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project's name REST API

Description

This is a the backend repository for the React application app's name.


Instructions

When cloning the project, change the sample.env file name for .env. The project will run on PORT 8000.

Then, run:

npm install

Scripts

  • To start the project run:
npm run start
  • To start the project in development mode, run:
npm run dev
  • To seed the database, run:
npm run seed

Models

User

Users in the database have the following properties:

{
  "username": String,
  "email": String,
  "hashedPassword": String
}

API endpoints and usage

Action Method Endpoint Req.body Private/Public
SIGN UP user POST /api/v1/auth/signup { username, email, password } Public
LOG IN user POST /api/v1/auth/login { email, password } Public
GET logged in user GET /api/v1/auth/me Private

Useful links

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published