jusygg / raven-notes

Collaborative note-taking without a fuss

 Raven Notes 

Collaborative note taking without a fuss.

Idea

There are many note taking applications out there, so why build another one?

We came up with the idea while participating in a coding bootcamp. While a lot of people were taking amazingly detailed notes, sharing these notes was always a very time-consuming process. We wanted to build an option that encourages collaboration and sharing knowledge between peers.

This is what sets Raven Notes apart:

• ✨ Unobtrusive interface
• 👫 Sharing by default
• 🐥 Keeping it simple

Technologies

• Electron
• React
• Redux
• Redux Saga
• GraphQL
• Apollo Server
• MySQL

Showcase

Get started

1. Clone the repository

> git clone https://github.com/carlhueffmeier/raven-notes.git

2. Install dependencies

> npm install

3. Configure your environment

> cp client-desktop/.env.example client-desktop/.env
# Edit client-desktop/.env

> cp server/.env.example server/.env
# Edit server/.env

4. Run the project

# Runs both client and server
> npm start

# Starts the desktop client
> npm run start:client

# Starts the server
> npm run start:server

Authors

The initial version was the result of a two week group project in Codeworks.

Original authors:

• Sae @saerose
• Rodrigo @RodriFS
• Nicola @Nikko89
• Carl @carlhueffmeier

Contributions

Contributions are always welcome! Please check the CONTRIBUTING.md.