fyindr
/
siimee
Sledovat 4
Oblíbit 3
Rozštěpit 1
Zdrojový kód Požadavky na natažení 1 Vydání 4 Wiki Aktivita
Nelze vybrat více než 25 témat Téma musí začínat písmenem nebo číslem, může obsahovat pomlčky („-“) a může být dlouhé až 35 znaků.
362 Revize
17 Větve
Strom: 51705db2b4
Větve Značky
${ item.name }
Vytvořit větev ${ searchTerm }
z „51705db2b4“
${ noResults }
siimee/backend
j 81eced6e29 :recycle: integrating chat view into pairs and reworking pubnub před 3 roky
..
db :wrench: majority styling + basic functionality for questionnaire před 3 roky
lib :recycle: fixing up tag schema | fixing up pairing před 3 roky
server :bug: passing messages to chatter in correct format | altering borked joi import před 3 roky
tests :recycle: fixing up tag schema | fixing up pairing před 3 roky
.env.sample :recycle: rebuilt aspect and prescore table migrations před 4 roky
.eslintrc eslint switch case update to match prettier před 3 roky
.nycrc :recycle: just cleaning up config stuff před 5 roky
.prettierrc :gear: redoing prettier config | running prettier | adding some sample wave-ui elements před 3 roky
README.md :recycle: a bunch of random changes before we get started před 3 roky
docker-compose.yml :recycle: integrating chat view into pairs and reworking pubnub před 3 roky
knexfile.js :recycle: integrating chat view into pairs and reworking pubnub před 3 roky
package-lock.json :recycle: integrating chat view into pairs and reworking pubnub před 3 roky
package.json connecting to pubnub but throwing an error on the publish před 3 roky

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