# :fist: SIIMEE

[![Build Status](http://gitea.yvvas.com:8000/api/badges/fyindr/siimee/status.svg)](http://gitea.yvvas.com:8000/fyindr/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` or `npm run nodev` if you want to remove restrictions on logging in and profile completeness
8. User a web browser to check `http://localhost:3000` 

## :ship: CI/CD

Included is a drone config, and some recommended steps to build. 

* You MUST activate the pipeline
* Add the `id_rsa` of the drone host to appropriate key in the pipeline secrets under the name `push_deploy_key`

You also need to setup a `post-receive` hook on the host server.

* On your *development* machine, add the target host as a remote `git remote add </opt/staging/siimee.git> staging master`
* Login to the *remote* machine and setup a bare git repo on `git init --bare </opt/staging/siimee.git>`
* Copy the `post-receive` hook file into the `</opt/staging/siimee.git/hooks/>` directory


## :satellite: Technology

### Frontend
See `./frontend/README.md`

### Backend
See `./backend/README.md`

### Database
Designed around `MariaDB` hosted by: [PlanetScale](https://planetscale.com)

## :scroll: License
UNLICENSED