https://github.com/passeriform/portfolio-api
A minimal API for serving configuration files
https://github.com/passeriform/portfolio-api
Last synced: 11 months ago
JSON representation
A minimal API for serving configuration files
- Host: GitHub
- URL: https://github.com/passeriform/portfolio-api
- Owner: Passeriform
- License: mit
- Created: 2020-07-13T22:27:51.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T10:26:26.000Z (over 3 years ago)
- Last Synced: 2023-03-04T18:47:22.092Z (over 3 years ago)
- Language: TypeScript
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
[travis-url]: https://travis-ci.org/nestjs/nest
[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
[linux-url]: https://travis-ci.org/nestjs/nest
A minimal API backend for supplying portfolio information. Uses Nest.js and Fastify under the hood and hosted on Heroku
## Using the API
You can access the publicly avaiable API at the heroku hosted link [here](passeriform-portfolio-api.herokuapp.com)
## Installation
```bash
$ npm install
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## License
This project is under [MIT license](LICENSE).