https://github.com/bengeendokter/hogent-fluvius-node
Node project van groepswerk.
https://github.com/bengeendokter/hogent-fluvius-node
node rest-api
Last synced: 2 months ago
JSON representation
Node project van groepswerk.
- Host: GitHub
- URL: https://github.com/bengeendokter/hogent-fluvius-node
- Owner: bengeendokter
- Created: 2022-06-28T15:32:41.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-28T15:40:26.000Z (about 4 years ago)
- Last Synced: 2025-02-05T11:45:06.753Z (over 1 year ago)
- Topics: node, rest-api
- Language: JavaScript
- Homepage: https://mvo-fluvius.herokuapp.com/api/
- Size: 196 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Het project opstarten
## Online versie
Deze API draait online via [heroku](https://mvo-fluvius.herokuapp.com/api/)
Voor een JWT token te ontvangen stuurt men een `POST` inlog request naar `https://mvo-fluvius.herokuapp.com/api/users/login` met volgende body:
```
{"GEBRUIKERSNAAM":"JanJansens", "WACHTWOORD":"123456789"}
```
Ook kan de online versie geraadpleegt worden via de [frontend op Netlify](https://mvo-fluvius.netlify.app/).
## Lokale versie
Voor een lokale versie van de API voert men na het clonen van de repository eerst volgend commando uit om alle packages te intaleren:
```
yarn install
```
Ook zal men een `mySQL database` nodig hebben en een `.env` file die er als volgt moet uitzien:
```
...
```
Indien de vorige stappen goed uitgevoert zijn kan men een lokale versie draaien via:
```
yarn start
```
De API draait nu op [http://localhost:9000](http://localhost:9000) en kan in de browser bekeken worden.
Ook hier kan men toegang krijgen via dezelfde inlog gegevens als de online versie.
### Testen
De testen kunnen uitgevoert worden via:
```
yarn test
```