Server template

This is a simple server template to for my students to start projects quickly.

Table of contents:

• Setup
• Endpoints
• Sample requests with axios
• Sample requests with httpie
• History of this project (pullrequests)

SETUP How to use this template

1. Create a new project based on this template using the Use this template button

2. Clone the app

git clone [email protected]:YOUR_GITHUB_NAME/YOUR_PROJECT_NAME.git

3. cd into your project

cd YOUR_PROJECT_NAME

4. install dependencies

npm install

5. Configure your database in config/config.json

Default config is setup for usage with an ElephantSQL database instance, you need to provide the DB Url on the "url" key of the config.json file, key development.

// config/config.json
{
  "development": {
    "url": "YOUR_ELEPHANTSQL_URL_HERE",
    "dialect": "postgres",
    "operatorsAliases": "0"
  },
}

If planning to use this template with a docker database the config object should be changed to:

// config/config.json
{
  "development": {
    "username": "postgres",
    "password": "secret",
    "database": "YOUR_PROJECT_NAME_HERE_development",
    "host": "localhost",
    "dialect": "postgres",
    "operatorsAliases": "0"
  }
}

And you must revert the changes on this line in models/index.js: https://github.com/Codaisseur/express-template/commit/ada7711c8b19c8f240bc61f94743213efe4a77d2#diff-18c449caa39363f82bacb4f7489e7783L15

6. Create database, run migrations & seed data

package.json contains a script for this

npm run initdev

Or run the commands seperately

npx sequelize-cli db:migrate
npx sequelize-cli db:seed:all

7. start server with nodemon (recommended for development)

npm run dev

8. or start normally

npm start

Endpoints

Method	Path	Purpose	required parameters	auth
GET	'/'	Test if your server is running	none	no
POST	'/echo'	Test POST requests	none	no
POST	'/signup'	Create a new user and get a token	email, name, password	no
POST	'/login'	Get a token with email & password	email, password	no
GET	'/me'	Get information of this user	none	yes
POST	'/authorized_post_request'	Test POST requests (token required)	none	yes

Sample requests with axios

To demo making request to this server, some small script are included that make requests using axios

The scripts can be found in /sampleRequests

1. Make sure to follow the the setup in this readme first
2. cd sampleRequests
3. Run example requests

node hello.js
node echo.js
node signup.js
node login.js
node me.js
node authorizedPost.js

Sample requests with httpie

To demo making request to this server, bash commands are included that make requests using httpie

They can found in ./sampleRequests/httpie.md

History of this project

• Setup of the server
• Adding a README
• Setting up the Database
• Signup, Login & auth middleware
• Configure cors
• Seed using models & add delay middleware