NotesAI is the best place to jot down quick thoughts, or to save longer notes from your classes
npm installnpm run test:silhouette: Lewis Silvia Erhan Vitali
Give a ⭐️ if this project helped you!
| Page | Description |
|---|---|
| Login/Register | Responsive pages that allow users to login and register |
| Notes | Main site page where users can view all their notes through AI summaries with random questions dynamically rendered based on those notes. |
| Notes/:id | Users can view their note with options to highlight text for definition and quiz themselves on said note. link to update note is also found here. |
| Note | Users can create a new note at which point an AI summary is generated along with a title if none is provided. If accesed via update button then fields will be |
| prepopulated. |
- To get the repository set up on your computer, open your terminal and move into your desired directory using the
cdcommand. - From the Code button copy the HTTPS/SSH key and run the command
git clonefollowed by the key you copied. - Run
npm installto install the necessary dependencies. - Create a new instance with Elephant SQL (or another PostgreSQL site) and copy the instance link created.
- In the root folder create a .env file and add the following lines:
- VITE_chatGPT_KEY=
Make sure there are no spaces between the content on each line and ensure you don't add any commas or any other punctuation at the end of each line.
When users first go to the site they are greeted with the landing page from which they are directed to either register or login. If the user doesn't have an account to begin with they are able to create an account.
Registering redirects to the login page when successful and Login redirects to the notes page.
The notes page displays all user notes along with questions based on said notes, navigation seen above changes dynamically based on the current page.
When a user clicks on an note on the main page they are redirected to the individual note page. The notes details are displayed here along with buttons that allow the user to utilise AI to understand and question themselves on their note.
The create note page allows users to create add their own note to the application with at which point the AI generates a summary and title if none is provided. This page dynamically adds the contents of a note if accesed with the update button the note page.
