https://github.com/ahzia/mlh-codebuddy-backend
https://github.com/ahzia/mlh-codebuddy-backend
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ahzia/mlh-codebuddy-backend
- Owner: ahzia
- License: mit
- Created: 2022-06-04T09:16:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-06T18:07:18.000Z (over 2 years ago)
- Last Synced: 2025-02-03T11:18:25.004Z (4 months ago)
- Language: JavaScript
- Size: 363 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# MLH Hackthon Codebuddy Backend
## Features
## Requirements
- [Node v7.6+](https://nodejs.org/en/download/current/) or [Docker](https://www.docker.com/)
- [Yarn](https://yarnpkg.com/en/docs/install)
## Getting Started
#### Clone the repo:
#### Install dependencies:
```bash
yarn
```
#### Set environment variables:
```bash
cp .env.example .env
```
## Running Locally
```bash
yarn dev
```
## Running in Production
```bash
yarn start
```
## Lint
```bash
# lint code with ESLint
yarn lint
# try to fix ESLint errors
yarn lint:fix
# lint and watch for changes
yarn lint:watch
```
## Test
```bash
# run all tests with Mocha
yarn test
# run unit tests
yarn test:unit
# run integration tests
yarn test:integration
# run all tests and watch for changes
yarn test:watch
# open nyc test coverage reports
yarn coverage
```
## Validate
```bash
# run lint and tests
yarn validate
```
## Logs
```bash
# show logs in production
pm2 logs
```
## Documentation
```bash
# generate and open api documentation
yarn docs
```
## Docker
```bash
# run container locally
yarn docker:dev
# run container in production
yarn docker:prod
# run tests
yarn docker:test
```
## Deploy
Set your server ip:
```bash
DEPLOY_SERVER=127.0.0.1
```
Replace my Docker username with yours:
```bash
nano deploy.sh
```
Run deploy script:
```bash
yarn deploy
```
## License
[MIT License](README.md)
## acknowledgment
We use this repo as a staterkit for our project:
[Express REST bilerplate - Daniel Sousa(MIT)](https://github.com/danielfsousa/express-rest-boilerplate)
[Daniel Sousa](https://github.com/danielfsousa)