raymozou / scratchnote

a simple note taking application

ScratchNote

A lightweight note taking application created using React.js and featuring icons from FontAwesome.

Usage

To use ScratchNote begin by cloning the repository. Then, navigate to the project folder via commmand line and type in "npm start" to enter the app in development mode. Open http://localhost:3000 to view it in the browser.

Notes

• Both the note title and content fields are required to create a note.
• ScratchNote currently only runs on a local instance
• Depending on your current settings, you may have to allow your IP address on the MongoDB console to allow read/write access to your database

Setup

1. Clone the repository with:

git clone https://github.com/RaymoZou/scratchnote

2. Install depencies with:

npm install

3. Create a .env in the server directory with the following fields:

MONGODB_URI={YOUR_MONGODB_URI_HERE}
PORT={PORT_NUMBER_HERE}

4. Create a .env in the client directory with following fields:

REACT_APP_SERVER_URL={BASE_URL_HERE}

Technology Stack