https://github.com/jvcjunior/node_express_functional
Node/Express API using some functional approach
https://github.com/jvcjunior/node_express_functional
docker knex lodash-fp node typescript
Last synced: 3 months ago
JSON representation
Node/Express API using some functional approach
- Host: GitHub
- URL: https://github.com/jvcjunior/node_express_functional
- Owner: jvcjunior
- Created: 2020-12-12T22:03:20.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-14T11:05:25.000Z (4 months ago)
- Last Synced: 2025-06-14T12:19:59.226Z (4 months ago)
- Topics: docker, knex, lodash-fp, node, typescript
- Language: TypeScript
- Homepage:
- Size: 1.41 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jungle Devs - Node Challenge
## Description
**Challenge goal**: The purpose of this challenge is to give an overall understanding of a backend application. You’ll be implementing a simplified version of news provider API. The concepts that you’re going to apply are:
- REST architecture :heavy_check_mark:
- Authentication and permissions :heavy_check_mark:
- Data modeling and migrations :heavy_check_mark:
- SQL database :heavy_check_mark:
- Query optimization :heavy_check_mark:
- Serialization :heavy_check_mark:
- Production builds :heavy_check_mark:
Added:
- Rate Limit
- Request Data validation with Joi
- Unit Tests with Jest
**Target level**: This is an all around challenge that cover both juniors and experience devs based on the depth of how the concepts were applied.
**Final accomplishment**: By the end of this challenge you’ll have a production ready API.
# THE PROJECT
## Requirements
- [Node.js](https://yarnpkg.com/en/docs/install)
- [Yarn](https://yarnpkg.com/en/docs/install)
- [NPM](https://docs.npmjs.com/getting-started/installing-node)
- [Docker](https://docs.docker.com/install/)
- [Docker Compose](https://docs.docker.com/compose/install/)
## Running the application - Development
**Run our app locally with sqlite database**
First, we need to install all depedencies:
```bash
yarn install or npm install
```
Once all dependencies are installed we now can run our application.
The fastest way of run our app is using a sqlite database. First, we need to make a copy of `.env.sqlite.local` and save as `.env`
```bash
cp .env.sqlite.local .env
```
Then we need to create our tables and add initial data:
Generate tables in database:
```bash
yarn run migrate:dev
```
Load fake data in database:
```bash
yarn run seed:dev
```
Now, just execute:
```bash
yarn start:dev
```
Our app is going to be running using port 5000.
**Run our app locally with postgres database running on Docker**
Make a copy of `.env.docker.development` and save as `.env`.
```bash
cp docker/.env.docker.development .env
```
Install dependencies and run the application locally.
```bash
docker-compose -f docker/docker-compose.dev.yml up -d db
```
Then we need to create our tables and add initial data:
Generate tables in database:
```bash
yarn run migrate:dev
```
Load fake data in database:
```bash
yarn run seed:dev
```
Now, just execute:
```bash
yarn start:dev
```
Our app is going to be running using port 5000.
**Run both our app and the database on Docker**
Make a copy of `.env.docker.development` and save as `.env`.
```bash
cp docker/.env.docker.development .env
```
Install dependencies and run the application locally.
```bash
docker-compose -f docker/docker-compose.dev.yml up -d
```
## Testing the application
it's really simple to test the aplpication see the results. You just need to run:
```bash
yarn test
```
## Running the application - Production
Make a copy of `.env.docker.production` and save as `.env`.
```bash
cp docker/.env.docker.production .env
```
TO run the app in prod you just need to run:
```bash
docker-compose -f docker/docker-compose.prod.yml up -d
```
After that, please run the following commands to create the database and run seeds:
```bash
docker exec -it api-prod yarn run migrate:prod
```
```bash
docker exec -it api-prod yarn run seed:prod
```