roykesydon/ribul

Ribul

Ribul is a twitter-like social network for sharing short messages. It is mainly built with Vue and Express.

This project is for learning purpose only. It is not intended to be used in production.

Demo

Docs

• API Document: backend/docs/API Document/README.md
  • This page is not finished yet

How to run (development)

1. write .env file

   cp .env.example .env

   Then, edit the .env file and fill in the correct values.

2. start the SQL server and Redis with docker

   docker-compose up -d

Backend

1. write backend/config.json file

   cd backend
   cp config.json.example config.json

   Then, edit the config.json file and fill in the correct values.

2. install dependencies

   npm install

3. for the first time, initialize the database and generate the test data. If you have already initialized the database, you can skip this step.

   node initDatabase.js
   node generateFakeData.js

4. start the server

   node app.js

Frontend

1. write frontend/.env file

   cd frontend
   cp .env.example .env

   Then, edit the .env file and fill in the correct values.

2. install dependencies

   npm install

3. start the server

   npm run dev