Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 1.97 KB

README.md

File metadata and controls

84 lines (57 loc) · 1.97 KB
Raw

prettier GitHub

📚 Einstein.kb - Open Source Knowledge Base Software

Einstein.kb is an open source software to make it easier to use and administer a knowledge base, allowing you to manage users, categories, and contents

Please feel free to clone, download or perhaps contribute

Demo site is here: Einstein.kb

Credentials for admin access
User: admin@einstein.kb
Password: admin

Main technologies with which this project was developed:

  • Node.js
  • Vue.js
  • PostgreSQL
  • MongoDB

✨ 🏃 Set up local Environment

Change the environment configuration file .env, with the access credentials for the database and your preferred private key

❗ Don't forget to install and create your database locally! (PostgreSQL and MongoDB)

# Clone this repository
$ git clone https://github.com/rminelli/einstein.kb

## Run Backend Server

# Go into the repository
$ cd backend

## Project setup
$ npm install

# Create database with knex
$ knex migrate:latest

# Run the app
$ npm start

# Run in production with pm2
$ npm run production

# The api is running at http://127.0.0.1:3800
* Use Postman a client REST to test the API.

## Run Frontend

# Go into the repository
$ cd frontend

# Project setup
$ npm install

# Compiles and hot-reloads for development
$ npm run serve

# Compiles and minifies for production
$ npm run build

# Lints and fixes files
$ npm run lint

License

MIT