https://github.com/mathieubesson/tricount-rat-api
Application based on the simplified functionalities of Tricount. (FRONT)
https://github.com/mathieubesson/tricount-rat-api
docker nextjs nodejs npm postgresql prisma
Last synced: 11 months ago
JSON representation
Application based on the simplified functionalities of Tricount. (FRONT)
- Host: GitHub
- URL: https://github.com/mathieubesson/tricount-rat-api
- Owner: MathieuBesson
- License: gpl-3.0
- Created: 2023-05-17T09:39:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T16:24:56.000Z (over 1 year ago)
- Last Synced: 2025-01-04T03:12:47.812Z (about 1 year ago)
- Topics: docker, nextjs, nodejs, npm, postgresql, prisma
- Language: TypeScript
- Homepage:
- Size: 361 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TricountRat API
This application is based on the simplified features of [Tricount](https://www.tricount.com/fr/faire-les-comptes-entre-amis).
## Prerequisites
## Configuration
### Defining Environment Variables
To use your own environment variables, you need to redefine the variables present in the `.env.example` file by creating a new `.env` file with your chosen values.
## Installation
The following command will start the `node`, `postgres`, and `pgadmin` containers required for the project using the images referenced in the `docker-compose.yml` file.
```bash
docker-compose up --build -d
```
Create the database:
```bash
docker exec tricount-rat-app npx prisma migrate dev
```
Seed the database with mock data (already done by the previous command):
```bash
docker exec tricount-rat-app npx prisma db seed
```
You can now access the various tools on the following ports:
- `API documentation`: [http://localhost:3000/api](http://localhost:3000/api) - API documented with Swagger
- `Postgres`: [http://localhost:5432](http://localhost:5432)
- `pgAdmin`: [http://localhost:5050](http://localhost:5050)
Log in to the various tools using the credentials from your `.env` file.
## Useful Information
- Install dependencies directly from the container:
```bash
docker exec tricount-rat-app npm install {package-name}
```
- Run the project in `production` mode:
```bash
docker exec tricount-rat-app npm run start:prod
```
## Front-end
The front-end of **TricountRat** is a web application built with **Next.js**. You can find it here: [tricount-rat-front](https://github.com/MathieuBesson/tricount-rat-front).
## TODO
- Fix the many typing issues or lack of typing
## License
This project is licensed under the GPL License. See the [LICENSE](./LICENSE) file for more details.