Your notes best stored here, on the cloud.

Index

• About
• Functionalities
• Technologies
• How to use

🔖 About

Everybody needs to write, either it's for studying, or to better organize your tasks of the week, notes are universal. Straight notes comes to solve your problem: create, edit, and access your notes from anywhere in the globe, you just need some device that can access the web and a internet connection.

⚡ Check it out

https://straight-notes-lamongabriel.vercel.app/

🔥 Functionalities

• Noting

  • Create your notes.
  • Edit.
  • Delete if you don't need anymore.
  • List and search every note you have.
  • Access then anywhere you are, with a PC or mobile phone.

• Security

  • Create your account, safely.
  • Every user has it's own notes, just login and start using.
  • Update your account info.

🚀 Technologies

The project is made with:

• React JS
• TypeScript
• JWT
• Node.js
• Express
• Bcryptjs
• Dotenv
• Mongo DB
• Mongoose

🔥 How to Use

• Dependencies

  • Is required to install Node.js
  • In order to run scripts and install dependencies you need to install a package manager, like yarn.
  
  

1. First step, clone this github repository:

  $ git clone https://github.com/lamongabrie/straight-notes.git

2. You need a mongoDB instance running your local machine, either install MongoDB community and run it or as i prefer use Docker.

Docker example:

$ docker run -d -p 27017:27017 --name mongo_db_straight_notes mongo

3. Setting up the API

$ cd /api
$ touch .env

You must set up a .env file to continue, like the following example:

SERVER_PORT=3001
DATABASE_URL='mongodb://127.0.0.1:27017/straightnotes'
SECRET=justonesinglesecret

Then, run the API.

$ yarn
$ yarn dev

4. Setting up the client

$ cd /web

Create .env file at the root of the /web folder and define a VITE_API_URL.

  $ # Define .env called VITE_API_URL
  $ VITE_API_URL: https://localhost.local:3001

Then, run the client.

$ yarn
$ yarn dev