https://github.com/alexw00/tsed-api
https://github.com/alexw00/tsed-api
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alexw00/tsed-api
- Owner: AlexW00
- Created: 2023-02-23T16:24:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T14:29:52.000Z (over 3 years ago)
- Last Synced: 2025-07-19T19:34:48.066Z (11 months ago)
- Language: TypeScript
- Size: 22.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphIT - Database API
The API server for the GraphIT database.
## Getting started
### Environment
This project requires a `.env` file in the root directory. You can use the `.env.example` file as a template.
### Building
> **Important!** Ts.ED requires Node >= 14, Express >= 4 and TypeScript >= 4.
```batch
# install dependencies
$ install
# serve
$ start
# build for production
$ build
$ start:prod
```
## Docker
```
# build docker image
docker compose build
# start docker image
docker compose up
```
## Barrelsby
This project uses [barrelsby](https://www.npmjs.com/package/barrelsby) to generate index files to import the controllers.
Edit `.barreslby.json` to customize it:
```json
{
"directory": ["./src/controllers/rest", "./src/controllers/pages"],
"exclude": ["__mock__", "__mocks__", ".spec.ts"],
"delete": true
}
```