https://github.com/hritik-6918/notesapp
This is a Repository to get started with AWS fullstack application
https://github.com/hritik-6918/notesapp
Last synced: 2 months ago
JSON representation
This is a Repository to get started with AWS fullstack application
- Host: GitHub
- URL: https://github.com/hritik-6918/notesapp
- Owner: hritik-6918
- Created: 2025-03-11T06:05:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-11T08:07:24.000Z (3 months ago)
- Last Synced: 2025-03-11T08:26:54.673Z (3 months ago)
- Language: TypeScript
- Size: 204 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
https://github.com/user-attachments/assets/c2e1af23-e1b1-4183-a6e1-f61bc736c291
# NotesApp (React + Vite + AWS Amplify)
## Overview
NotesApp is a React-based note-taking application powered by Vite and AWS Amplify. It allows users to create, view, and delete notes with text and images. Authentication and data storage are managed using AWS Amplify services.
## Features
- User authentication with AWS Amplify
- Create, read, and delete notes
- Image upload and storage
- Real-time updates using AWS Amplify Data
- Built with React, Vite, and AWS Amplify
## Tech Stack
- **Frontend:** React, Vite
- **Backend:** AWS Amplify (Auth, Data, Storage)
- **Deployment:** AWS Amplify
## Installation
### Prerequisites
Ensure you have the following installed:
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
- AWS Amplify CLI (`npm install -g @aws-amplify/cli`)
### Setup
1. **Clone the repository:**
```sh
git clone https://github.com/yourusername/notesapp.git
cd notesapp
```
2. **Install dependencies:**
```sh
npm install
```
3. **Configure AWS Amplify:**
```sh
amplify init
amplify push
```
4. **Run the development server:**
```sh
npm run dev
```
## Usage
- Open the app in your browser at `http://localhost:5173`.
- Sign in or sign up using AWS Amplify authentication.
- Create notes with a name, description, and optional image.
- View all saved notes.
- Delete unwanted notes.
## Available Scripts
| Script | Description |
| ----------------- | ---------------------------- |
| `npm run dev` | Start the development server |
| `npm run build` | Build the production files |
| `npm run preview` | Preview the production build |
| `npm run lint` | Run ESLint checks |
## AWS Amplify Backend
The backend is defined in the `amplify/` directory and includes:
- **Auth:** User authentication setup (`auth/resource.ts`)
- **Data:** Note storage and authorization (`data/resource.ts`)
- **Storage:** Image file handling (`storage/resource.ts`)
---
Developed by **curious_hritik** 🚀