This project is a clone of the notes app on iOS built using React, TypeScript, Bootstrap, Redux, JSONbin and Axios. The purpose of this project is to exercise, apply and practice certain key skills and principles required in frontend web development.
To run this project locally, please follow these steps:
- Clone the repository
git clone https://github.com/yubinjodev/apple-notes.git
- Navigate to the project directory
cd apple-notes
- Install the dependencies
npm install
Once the installation is complete, you can start the development server by running the following command:
npm start
This will start the application at http://localhost:3000 in your browser. Any changes you make to the source code will automatically refresh the page.
- Authentication
- Login
- Sign up
- CRUD
- Create notes
- See your saved notes
- Edit your notes
- Delete your notes
This project utilizes the following technologies:
- Language : Typescript
- Framework : React
- Build tools : NPM
- CSS Framework : Bootstrap
- "Backend" : JSONBin
- State Management : Redux & Redux Persist
- API Client : Axios
- Unit testing : Jest
- E2E testing : Playwright
- Understand and practice the SOLID principle
- Single responsibility
- Open-closed
- Liskov substitution
- Interface segregation
- Dependency inversion
- Utilize custom hooks
- Practice state management through Redux
- Getting familiar with authentication
- Exercise async handling
- Executing database usage and API fetching
- Engaging in intermediate TypeScript features and clean-code naming conventions
Contributions to this project are welcome. If you find any issues or have suggestions for improvements, feel free to open a new issue or submit a pull request. Not sure how to do that? Check this out
When contributing, please adhere to the existing code style and follow the GitHub Flow for collaboration.
This project is licensed under the MIT License. You are free to use, modify, and distribute this code as long as the original license terms are included.