https://github.com/chrisru/beight-api
✏️ Backend for a collaborative web editor
https://github.com/chrisru/beight-api
docker docker-compose eslint koa nodejs passportjs postgresql typescript webpack websocket
Last synced: 2 months ago
JSON representation
✏️ Backend for a collaborative web editor
- Host: GitHub
- URL: https://github.com/chrisru/beight-api
- Owner: ChrisRu
- License: mit
- Created: 2017-08-19T11:11:59.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-21T16:24:52.000Z (over 8 years ago)
- Last Synced: 2025-01-25T15:30:34.260Z (over 1 year ago)
- Topics: docker, docker-compose, eslint, koa, nodejs, passportjs, postgresql, typescript, webpack, websocket
- Language: TypeScript
- Homepage:
- Size: 375 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Beight Core
A collaborative web editor built with Node, PostgreSQL, Typescript, KoaJS, PassportJS and WS.
This is the backend/API for the Beight application. If you want the full experience, go to https://github.com/ChrisRu/beight-client and install the frontend.
# License
This application is MIT licensed
# Setup
1. Install Docker Compose
If you don't have docker compose installed, follow the instructions on https://docs.docker.com/compose/install/
2. Configure the environment variables
- Move or copy the `.env.example` file to just `.env`
- Optionally configure the environment variables to your liking
3. Build the containers
Start the build by running the following command inside the root folder:
`docker-compose build`
4. Everything should work now :)
Next up: running the dev server
# Running
1. Start the containers
Start the containers by running the following command inside the root folder:
`docker-compose up`
2. Optionally, install the dev dependencies to get eslint and type support inside your prefered editor
- I recommend using [prettier](https://github.com/prettier/prettier) with [prettier-eslint](https://github.com/prettier/prettier-eslint) for code formatting.
- The editor I recommend is [VSCode](https://github.com/Microsoft/vscode). It's great for type support.
`npm install --only=dev`
2. Done :)
You can now edit the files and the server will automatically restart when a file changes.
Press CTRL+C to exit.