fyindr
/
siimee
Tarkkaile 4
Äänestä 3
Fork 1
Koodi Pull-pyynnöt 1 Julkaisut 4 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
316 Commitit
17 Branchit
Puu: 322349689d
Branchit Tagit
${ item.name }
Create branch ${ searchTerm }
from '322349689d'
${ noResults }
siimee/backend
J 77a0df8555 :sparkles: first pass nav 3 vuotta sitten
..
db :recycle: removed false positives from prescore matrix by swapping in euclidean distance for cosine similarity 3 vuotta sitten
lib :recycle: fixing all tests | finishing grouping and membership join test 3 vuotta sitten
server :bug: passing messages to chatter in correct format | altering borked joi import 3 vuotta sitten
tests :recycle: fixing all tests | finishing grouping and membership join test 3 vuotta sitten
.env.sample :recycle: rebuilt aspect and prescore table migrations 4 vuotta sitten
.eslintrc eslint switch case update to match prettier 3 vuotta sitten
.nycrc :recycle: just cleaning up config stuff 5 vuotta sitten
.prettierrc :gear: redoing prettier config | running prettier | adding some sample wave-ui elements 3 vuotta sitten
README.md :recycle: a bunch of random changes before we get started 3 vuotta sitten
docker-compose.yml :gear: enforcing usage of env file port 4 vuotta sitten
knexfile.js local changes necessary to get frontend and backend running 3 vuotta sitten
package-lock.json :sparkles: first pass nav 3 vuotta sitten
package.json connecting to pubnub but throwing an error on the publish 3 vuotta sitten

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