fyindr
/
siimee
Beobachten 4
Favorisieren 3
Fork 1
Code Pull-Requests 1 Releases 4 Wiki Aktivität
Du kannst nicht mehr als 25 Themen auswählen Themen müssen mit entweder einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
166 Commits
17 Branches
Struktur: c1983ea586
Branches Tags
${ item.name }
Erstelle Branch ${ searchTerm }
von „c1983ea586“
${ noResults }
J c1983ea586 :recycle: adjusted grouping return for matches vor 4 Jahren
backend :recycle: adjusted grouping return for matches vor 4 Jahren
docs :pencil: adding docs on how some process works vor 4 Jahren
frontend :pencil: adding in some comments vor 4 Jahren
public :tada: first commit vor 5 Jahren
.gitignore :sparkles: including a generated matrix of scores vor 4 Jahren
README.md :pencil: typo README.md vor 5 Jahren

README.md

:fist: SIIMEE

Almost everything you need to develop.

:wrench: Tooling

Node.js and npm

We use javascript here. .eslintrc and .prettierrc configs are provided to help make your code nice to read.

Docker and docker-compose

Docker manages packaging for development and testing, environment variable things, and not much else.

git

We use git for source control but you knew that already.

:pencil: Full Documentation

See ./docs

:battery: Installation & Getting Started

  1. Navigate to the ./backend directory and run npm install to install backend dependencies
  2. Copy the server environmental variables sample file from ./server/.env.sample and remane it to ./server/.env
  3. Start the minimal docker-compose file provided to bootstrap a development database using the command docker-compose --env-file ./server/.env up -d
  4. Create tables and populate the database with some test data using npm run migrate and npm run seed from the ./backend directory
  5. Start the backend using npm run start
  6. Navigate to the ./frontend directory and run npm install
  7. Start the frontend development server with npm run dev
  8. User a web browser to check http://localhost:3000

:ship: CI/CD

TBD

:satellite: Technology

Frontend

See ./frontend/README.md

Backend

See ./backend/README.md

Database

Designed around MariaDB hosted by: PlanetScale

:scroll: License

UNLICENSED