@ -3,7 +3,6 @@
An online storefront to showcase products. Users is able to browse an index of all products, see the specifics of a single product, and add products to an order that they can view in a cart page.
# Installation
1 - Install packages dependencies. `npm install`
@ -12,52 +11,56 @@ An online storefront to showcase products. Users is able to browse an index of a
4 - Run the database `npm run up`
5 - Launch the application `npm run start`
Note : If needed you can reset the tables by closing the app and running `npm run down` , `npm run up`
Note : If needed you can reset the tables by closing the app and running the following commands :
- `npm run down`
- `npm run up`
# Availaible endpoints
- Products :
- get `/products` , Index
- get `/products/:id` Read
- post `/products` Create ( Token )
- put `/products/:id` Update ( Token )
- delete `/products/:id` Delete ( Token )
| HTTP Verb | Endpoint | CRUD |
|:-------------: |:-------------------:| -----------------:|
| get | `/products` | Index |
| get | `/products/:id` | Read |
| post | `/products` | Create ( Token ) |
| put | `/products/:id` | Update ( Token ) |
| delete | `/products/:id` | Delete ( Token ) |
| HTTP Verb | Endpoint | CRUD |
|:--------------:|:--------------------|:-----------------|
| Get | `/products` | Index |
| Get | `/products/:id` | Read |
| Post | `/products` | Create ( Token ) |
| Put | `/products/:id` | Update ( Token ) |
| Delete | `/products/:id` | Delete ( Token ) |
- Users :
- get `/users` , Index ( Token )
- get `/users/:id` Read ( Token )
- post `/users` Create
- post `/users/auth` Authenticate ( Token )
- put `/users/:id` Update ( Token )
- delete `/users/:id` Delete ( Token )
| HTTP Verb | Endpoint | CRUD |
|:--------------:|:--------------------|:-----------------------|
| Get | `/users` , | Index ( Token ) |
| Get | `/users/:id` | Read ( Token ) |
| Post | `/users` | Create |
| Put | `/users/auth` | Authenticate ( Token ) |
| Put | `/users/:id` | Update ( Token ) |
| Delete | `/users/:id` | Delete ( Token ) |
- Orders
- Orders :
| HTTP Verb | Endpoint | CRUD |
|:--------------:|:-----------------------|:-----------------|
| Get | `/orders` , | Index ( Token ) |
| Get | `/orders/:id` | Read |
| Post | `/orders` | Create |
| Post | `/orders/:id/products` | Create ( Token ) |
| Delete | `/orders/:id/products` | Delete ( Token ) |
- get `/orders` , Index ( Token )
- get `/orders/:id` Read ( Token )
- post `/orders` Create
- post `/orders/:id/products` Authenticate ( Token )
- delete `/orders/:id/products` Delete ( Token )
# Built with
- Typescript
- Postgres for the database
- Node/Express for the application logic
- Dotenv from npm for managing environment variables
- Db-migrate from npm for migrations
- Jsonwebtoken from npm for working with JWTs
- Jasmine/Supertest from npm for testing
- Postgres
- Node
- Express
- Dotenv
- Db-migrate
- Jsonwebtoken
- Jasmine
- Supertest
# Author
