https://github.com/karmek-k/remind-me
📢 Reminding you by all means!
https://github.com/karmek-k/remind-me
Last synced: 3 months ago
JSON representation
📢 Reminding you by all means!
- Host: GitHub
- URL: https://github.com/karmek-k/remind-me
- Owner: karmek-k
- License: agpl-3.0
- Created: 2021-09-17T16:01:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-07T17:07:06.000Z (over 3 years ago)
- Last Synced: 2025-01-11T01:50:57.509Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 722 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Remind Me
## Installation
### Preview
You can quickly set up the API with Docker and `docker-compose`.
```
docker-compose -f docker-compose.prod.yml up
```
Don't worry if the API throws errors about not being able to connect
to the database - it will restart and start working.
### Development
```
docker-compose -f docker-compose.dev.yml up
```
Note that this command won't start the API, it simply provisions PostgreSQL and Redis.
In order to run the API:
```
cd backend
npm run build
npm run dev
```
Actually you don't have to run `npm run build` as the `dev` script does it automatically,
but without it you may get a `file not found` error.
## Using the API
Because the frontend is not finished yet, please use a GraphQL API client like [Insomnia](https://insomnia.rest/).
As for now, the backend allows for API introspection in all environments, so there should be no problem with using it.