Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/notaphplover/axel
Typescript 4 API REST experiment
https://github.com/notaphplover/axel
Last synced: 2 days ago
JSON representation
Typescript 4 API REST experiment
- Host: GitHub
- URL: https://github.com/notaphplover/axel
- Owner: notaphplover
- License: cc0-1.0
- Created: 2020-09-04T09:45:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-01-15T17:40:39.000Z (about 3 years ago)
- Last Synced: 2024-11-17T20:49:33.865Z (2 months ago)
- Language: TypeScript
- Size: 4.63 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/notaphplover/axel/workflows/ci/badge.svg)
# Axel
The not-an-mtg-engine open project! (In progress)
## Status of the project
This project was born as a test to try new software architecture approaches DDD based.
This project is now a WIP with no roadmap, so ***don't put your faith in it*** (for now).
## Getting started
1. Clone the repo.
2. Install the dependencies:
```
npm ci
```
3. Build the source code:
```
npm run build
```
4. Run the setup script
```
npm run setup:local
```
5. Launch docker images:
```
docker-compose up
```
6. Start local server
```
npm run start
```
7. Enjoy!
### Tests
Tests can be passed with the test script
```
npm t
```
***Note***: Non unit tests may require all the docker images up
```
npm run docker:up:test
```
## Launching services
Services can be launched in multiple ways.
### Using dockerized services
Just follow the steps on the `Getting started` section and start run the docker-compose build:
```
docker-compose up
```
Once the docker services are up, just start the local server:
```
npm run start:prod
```
### Using kubernetes services
This project includes a kubernetes config to launch a cluster at the `kubernetes` folder. You can use minikube to launch the cluster.
```
minikube start
```
Keep in mind ingress addon must be enabled. You can enable this addoin with the following command:
```
minikube addons enable ingress
```
The backend deployment is accesed through an ingress. The following command is required to allow the backend service to be reachable from the host machine:
```
minikube tunnel
```
Now you can load the config
```
kubectl apply -f ./kubernetes
```
Wait for the pods to be ready. Once they are, the API should be accesed through the external IP of the `api-server-service` service
```
kubectl get services api-server-service
```