farhanmobashir / ampere-doc Goto Github PK

• About Ampere-Docs
• Technology and libraries used
• Pre-requisites and project setup(in local)
• Let us connect

Ampere-Docs - a note taking app to note down the things that matter to you

• Home - a regular landing page.

• Notes - all notes at one place(can be accessed only if the user is logged in). Users can

  • view and edit notes
  • add new notes
  • send notes to trash
  • send notes to archive
  • change note color
  • add tags
  • add priority
  • sort notes based on tag , priority , and date

• Archive Page - List of archived note. Users can

  • view archived notes
  • restore archive note

• Trash Page - List of notes sent to trash. User can

  • view trashed notes
  • restore trashed note
  • delete permanently from trash

• Authentication - User can login as guest only, login with credentials, signup and logout. Once the user is logged in, they can access their notes.

• [Add note page]https://ampere-doc.netlify.app/) - add a new note. User can:

  • add note title
  • add note body
  • add tag
  • add note color
  • add priority

• ReactJS
• Firebase Authentication
• AmpereUI Component Library
• React Router

• Responsiveness - This app is completely responsive and can be accessed in all kind of devices.
• Proper messages for error/exception handling across the application
• Use of loader to show status of tasks

Install NodeJs(if not already installed)

Clone dev branch of this repo to local using:

 git clone https://github.com/FarhanMobashir/ampere-doc.git -b dev

Go into the project folder

 cd project-name

Install all the npm packages

 npm install

Run the application using:

 npm start

The application runs on localhost:3000