https://github.com/substance/notes

Real-time collaborative notes editing.
https://github.com/substance/notes

Last synced: 7 days ago
JSON representation

Real-time collaborative notes editing.

• Host: GitHub
• URL: https://github.com/substance/notes
• Owner: substance
• License: other
• Created: 2016-02-10T09:54:46.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-24T12:24:46.000Z (about 8 years ago)
• Last Synced: 2024-08-02T02:16:19.696Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 482 KB
• Stars: 21
• Watchers: 6
• Forks: 5
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-starred - substance/notes - Real-time collaborative notes editing. (others)

README

        
# Substance Notes [![Build Status](https://travis-ci.org/substance/notes.svg?branch=master)](https://travis-ci.org/substance/notes)

Real-time collaborative notes editing.

# Install

Clone the repo

```bash

git clone https://github.com/substance/notes.git

```

Install dependencies

```bash

npm install

```

Seed the db

```bash

npm run seed dev

```

Start the app

```bash

npm start

```

To login with the test user:

```bash

http://localhost:5000/#loginKey=1234

```

# Configuration

You can configure app for different environments.

To do that just make a new copy of ```default.json``` from ```config``` folder with name of your environment and run:

```bash

export NODE_ENV=myEnv

```

For example you can create config/production.json and then run ```export NODE_ENV=production```.

You should run seed after executing this command

# Bundling

Server will serve bundled version of app in production mode. So you should execute this command before:

```bash

npm run bundle

```