fyindr
/
siimee
Observar 4
Favorito 3
Fork 1
Código Pull requests 1 Versões 4 Wiki Atividade
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
365 Commits
17 Branches
Branch: user-online-status
Branches Tags
${ item.name }
Criar branch ${ searchTerm }
de user-online-status
${ noResults }
siimee/backend
juancarbajal98 5b95b0f114 :construction: runtime array to manage all logged in users + incrementing array + accessing array for search 3 anos atrás
..
db another pre-release (#53) 3 anos atrás
lib :construction: runtime array to manage all logged in users + incrementing array + accessing array for search 3 anos atrás
server :construction: runtime array to manage all logged in users + incrementing array + accessing array for search 3 anos atrás
tests :recycle: fixing up tag schema | fixing up pairing 3 anos atrás
.env.sample another pre-release (#53) 3 anos atrás
.eslintrc eslint switch case update to match prettier 3 anos atrás
.nycrc :recycle: just cleaning up config stuff 5 anos atrás
.prettierrc :gear: redoing prettier config | running prettier | adding some sample wave-ui elements 3 anos atrás
README.md :recycle: a bunch of random changes before we get started 3 anos atrás
docker-compose.yml :recycle: integrating chat view into pairs and reworking pubnub 3 anos atrás
knexfile.js another pre-release (#53) 3 anos atrás
package-lock.json another pre-release (#53) 3 anos atrás
package.json another pre-release (#53) 3 anos atrás

README.md

siimee backend API

An API for the siimee application

:white_check_mark: Prerequisites

You will need…

Node.js 14+

:package: Installation

  1. Install dependencies with npm install
  2. Copy the environments sample file from ./backend/.env.sample and rename it to ./backend/.env
  3. Fill out your database connection details in ./backend/.env
  4. A test database container is provided and can be started with docker-compose up -d
  5. Populate some basic tables for your database using npm run generate && npm run reseed

:package: Migrations

We use Knex.js,which comes with a couple nice database migration and seeding tools. Migrating tracks changes in schema. Migration steps are contained in the ./db/migrations folder. Seeding adds dummy data once our database tables have been created and schemas are set. Starting seed steps are contained in ./db/seeds and use the mock.js file as the main dummy data source.

Migrating

  • Run npm run migrate to run all migrations and establish the base schema
  • Run npm run unmigrate to roll back one migration

Seeding

  • Run npm run generate to generate dummy data
  • Run npm run seed to seed the database with generated dummy data

Restarting

Since we can’t unseed the database, it’s best to destroy the dev database and rebuild it.

  1. Stop the database by navigating to the project root directory cd ../ and running docker-compose down
  2. Destroy the database volume docker volume rm siimee_siimee_db. BE CAREFUL.
  3. Restart the database while still at the project root with docker-compose up -d
  4. Recreate schemas,tables and dummy data by navigating to ./backend and running npm run reseed

:electric_plug: Run

  1. Run npm run start to start up the server
  2. Check http://localhost:3001/documentation to see the interactive API documentation

:robot: Deployment

TBD

:pill: Tests & Code Quality

Tests are run with AVA with code coverage reporting via nyc. Look at the example test for ideas, as well as the ava documentation

  • Run tests with coverage report with npm test

:heart: Built With