https://github.com/splorg/card-generator-api
An API for generating cards based on the game Inscryption.
https://github.com/splorg/card-generator-api
docker eslint express mongoose nodejs typescript
Last synced: 6 months ago
JSON representation
An API for generating cards based on the game Inscryption.
- Host: GitHub
- URL: https://github.com/splorg/card-generator-api
- Owner: splorg
- Created: 2023-05-08T00:18:24.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-08T00:27:32.000Z (over 2 years ago)
- Last Synced: 2025-06-21T18:40:27.742Z (7 months ago)
- Topics: docker, eslint, express, mongoose, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# card-generator-api
An API for generating cards based on the game Inscryption.
## Features:
- [x] Tribes, Temples, Skills and Cards CRUD
- [x] Schema validation through Mongoose
- [x] Filtering of cards by rarity, tribe, temple or skill
## Running the Project
If you just want to see the project in action, I recommend using Docker for a quicker setup:
```bash
# clone the project
git clone git@github.com:splorg/card-generator-api.git
# move to the project folder
cd card-generator-api
# run docker-compose
docker compose up -d
```
The API will now be available on http://localhost:3000/
If you want to run the project locally, you will need Node.js installed and a MongoDB database.
```bash
# clone the project
git clone git@github.com:splorg/card-generator-api.git
# move to the project folder
cd card-generator-api
# rename ".env.example" to ".env"
# add to .env your MongoDB connection string and the port you want to use
# install the project dependencies:
npm i
# start the project
npm run dev
```
###