Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 1.89 KB

README.md

File metadata and controls

68 lines (46 loc) · 1.89 KB
Raw

Notes-app-mern

Live version 🔌 on Heroku

This web app allows users to create an account and save, delete, edit notes in markdown. Users can also export the notes as PDF.

Technologies used -

  • Frontend
    • React.js
    • React Bootstrap
    • Axios
    • react redux
  • Backend
    • Node.js and Express
    • Jsonwebtokens
    • Bcrypt
    • MongoDB & mongoose
  • Dev dependencies
    • concurrently
    • nodemon

Upcoming features (I want to add)

  • Exporting the notes as PDF
  • Adding notes and organising them based on categories
  • Real time collaboration while editing notes
  • Improving the UI
  • Adding audio notes
  • Viewing other user's notes

Screenshot

Screenshot (35)

Use npm install to install all dependencies after going into specific directories.

How to start in development mode

cd into server directory and then

npm run dev

this will run both frontend and backend concurrently

If you want to contribute

If you want to contribute or help us out with a feature then create a seperate branch and add a pull request. For more details on how to contribute you can refer to First Contribution.

Getting Started with Create React App

This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!