meal-scheduler-backend

https://github.com/vauxgomes/meal-scheduler-backend

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (10.8%) to scientific vocabulary

Last synced: 10 months ago · JSON representation ·

Repository

Basic Info

Host: GitHub
Owner: vauxgomes
Language: JavaScript
Default Branch: master
Size: 185 KB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 0

Created about 4 years ago · Last pushed almost 4 years ago

Metadata Files

Readme Citation

README.md

Meal Scheduler Backend

Description

Basic Node.js backend for managing meals in Brazilian Federal Institutes of Technology.

Development Installation

After cloning this repository...

```sh

Install packages

npm install # may or may not need sudo permission

Create db/

mkdir db

Use knex to set the database

npx knex migrate:latest --env development npx knex seed:run --env development ```

Running application on Docker

sh docker build . -t <your username>/meal-server docker run -p 3333:3333 --name meal-server -d <your username>/meal-server

Running with docker-compose

```sh

Start

docker-compose up -d

Stop containers

docker-compose down ```

Both docker and docker-compose is set to use the staging profile.

Environment Variables Example

Development Profile

```sh

Server

NODEENV=production PORT=3333 TIMEZONE=America/Fortaleza

Encrypting

HASH_SALT=10

TOKEN

TKKEY= TKEXP=4h ```

Staging Profile (MySQL on Docker)

For running Knex with MySQL append the following variables to the development variables within .env.

```sh

Database

DBHOST=172.17.0.1 DBPORT=3306 DBUSER=root DBPASSWORD= # Fill here DB_DATABASE= # Fill here ```

*DB_HOST is set for using Docker. It may not be the best practice.

PostGresql

For running Knex with MySQL append the following variables to the development variables within .env.

```sh

Database

DBCONNSTR= # Fill here ```

For PostGresql it is required to activate an extension before running Knex migration scripts:

```sql -- ALLOW THE FOLLOWING EXTENSION FOR CREATING UUIDs CREATE EXTENSION IF NOT EXISTS "uuid-ossp"; ALTER EXTENSION "uuid-ossp" SET SCHEMA public;

-- CHECK IF IT IS WORKING SELECT genrandomuuid(); ```

Citation

In case you want to cite this project:

bibtex @software{Gomes_Meal_Scheduler_Backend_2022, author = {Gomes, Vaux Sandino Diniz}, month = {4}, title = {{Meal Scheduler Backend}}, version = {1.0.0}, year = {2022} }

Owner

Name: Vaux Gomes
Login: vauxgomes
Kind: user
Location: Brasil
Company: IFCE & Furukawa

Website: vauxgomes.github.io
Repositories: 12
Profile: https://github.com/vauxgomes

- Professor at IFCE - Working as a programer for Furukawa Eletric LatAm in association with IFCE

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Gomes
    given-names: Vaux Sandino Diniz
    orcid: https://orcid.org/0000-0001-7672-0643
title: "Meal Scheduler Backend"
version: 1.0.0
date-released: 2022-04-07

GitHub Events

Total

Last Year

Dependencies

package-lock.json npm

232 dependencies

package.json npm

nodemon ^2.0.16 development
bcrypt ^5.0.1
cors ^2.8.5
dotenv ^16.0.1
express ^4.18.1
jsonwebtoken ^8.5.1
knex ^2.0.0
pg ^8.7.3
sqlite3 ^5.0.8