added notes and more scripts

This commit is contained in:
adhamhaddad 2023-04-26 13:44:28 +02:00
parent c3b6f596eb
commit c9595ccb61

View File

@ -48,12 +48,21 @@ This project uses `eslint` and `prettier`. all configurations for this project i
4- `GRANT ALL PRIVILEGES ON DATABASE authentication TO admin;`
**[2]** Second to install the node_modules run `npm install` or `yarn`. After installation is done start the api in dev mode with `npm run dev` or `yarn dev`.
**[2]** Second to install the node_modules run `npm install` or `yarn install`. After installation is done
migrate up the database table schema with `npm run migrate:up` or `yarn migrate:up`
or run the `script.sh` in `sql` folder from root directory with `./script.sh`
after that start the api in dev mode with `npm run dev` or `yarn dev`.
## Unit Tests
Unit test available using Jasmine with this command: `npm run test`
## Important Note
```
To use refreshToken in the front end I provided a file called react.js in the documents folder.
```
## Available Scripts
In the project directory, you can run:
@ -82,6 +91,14 @@ It's format TypeScript to JavaScript
Build and runs the app in the clients mode.
Open <http://localhost:3000/> to view it in the browser.
##### `npm run migrate:up` or `yarn migrate:up`
Migrate up the database tables
##### `npm run migrate:down` or `yarn migrate:down`
Migrate up the database tables
## Built With
- [Node](https://nodejs.org) - Javascript runtime