Go to file
garrettmills f5e1f8eb9b
All checks were successful
continuous-integration/drone Build is passing
Drone: env subst
2022-11-29 14:55:02 -06:00
app Add real-time collab controller for markdown 2021-04-24 11:40:42 -05:00
config #4 - add support for sharing pages publicly, without login 2021-03-04 11:26:14 -06:00
deploy Add kubernetes deployment specs 2022-06-25 21:42:00 -05:00
flaps Big Bang 2020-02-07 19:50:10 -06:00
uploads Big Bang 2020-02-07 19:50:10 -06:00
.drone.yml Drone: env subst 2022-11-29 14:55:02 -06:00
.gitignore Enable file uploader component 2020-02-09 04:37:21 -06:00
azure-pipelines.yml Update azure-pipelines.yml for Azure Pipelines 2020-02-08 20:09:20 +00:00
BUILD.txt Update gitignore, add build info 2020-02-07 20:56:24 -06:00
docker-compose.yml Big Bang 2020-02-07 19:50:10 -06:00
docker.env Big Bang 2020-02-07 19:50:10 -06:00
Dockerfile Add kubernetes deployment specs 2022-06-25 21:42:00 -05:00
example.env Add development info to README 2021-08-30 16:08:27 -05:00
flaps.json Big Bang 2020-02-07 19:50:10 -06:00
flitter Big Bang 2020-02-07 19:50:10 -06:00
index.js Big Bang 2020-02-07 19:50:10 -06:00
LICENSE Big Bang 2020-02-07 19:50:10 -06:00
package.json Add kubernetes deployment specs 2022-06-25 21:42:00 -05:00
README.md Add yarn info to README 2021-08-30 16:09:13 -05:00
tag.txt tag 2021-03-04 11:38:09 -06:00
Units.flitter.js Start real-time collaboration for wysiwyg; flitter sockets 2021-01-02 15:12:29 -06:00
yarn.lock Update libflitter 2021-04-23 11:00:14 -05:00

noded/backend

Requirements to develop

  • Node.js 14.x
  • MongoDB 4.x
  • Yarn package manager (version 1.x)

Setting up develop

  • Clone this repo
  • Run yarn install
  • Copy example.env to .env
  • Edit .env
    • Change LOGGING_LEVEL to 7
    • Change database information, if necessary
    • Change ENVIRONMENT to development
    • Change UPLOAD_DEFAULT_STORE to flitter
      • You can leave this as s3 if you specify an S3-compatible API and credentials.
  • Make sure Flitter can start using ./flitter test

Basics

  • Run node index.js to start the main server.
    • I like to use nodemon to auto-reload when files change.
  • To access the shell for debugging & testing, run:
    • node --experimental-repl-await flitter shell