https://github.com/high-voltaged/ucode-usof-backend

A REST API for a developer forum, written using the MVC architecture.
https://github.com/high-voltaged/ucode-usof-backend

api-rest docker expressjs mvc mysql node redis

Last synced: about 6 hours ago
JSON representation

A REST API for a developer forum, written using the MVC architecture.

• Host: GitHub
• URL: https://github.com/high-voltaged/ucode-usof-backend
• Owner: High-Voltaged
• Created: 2022-10-01T22:53:39.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-09T10:13:58.000Z (about 2 years ago)
• Last Synced: 2023-03-08T18:25:27.549Z (over 1 year ago)
• Topics: api-rest, docker, expressjs, mvc, mysql, node, redis
• Language: JavaScript
• Homepage:
• Size: 206 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Usof-Backend

## About

This is a forum platform (StackOverflow analogy) which can be used by developers to exchange their opinions on different issues they're facing.

## Requirements & dependencies

- Node.js (version 14.15.4 or higher)

- NPM (version 6.14.0 or higher)

- Redis

- MySQL

- Docker (_optional_, see below)

## Install & run

Prior to setup, create an `.env` file based on the `.env.example` file, and fill in the required vars.

Then proceed:

1. Via Docker:

- Enter the root directory of the repository.

- Ensure that you don't have mysql or redis running on your local machine.

- Run `docker compose up -d`.

- Optionally, to run seeders & migrations, run `docker compose run --rm api npm run migrate:up`

2. Locally

- Install all the required dependencies, listed above.

- Run `npm install` in the root directory of the repository.

- Optionally, to run seeders & migrations, run `npm run migrate:up`.

- Run `npm start`.

You can now access the API, using the host and port, provided in the `.env` file.

## Diagrams

Entity-Relationship Diagram