🎁 Notifications menu with birthday reminders
Author: Carlos Alves - @EuCarlos
🌐 Para a versão em português deste README, clique aqui.
- 1. How to run the project
- 2. General Objective
- 3. Functional requirements
- 4. Non-Functional Requirements
- 5. How to contribute to this project
- 6. How do I report a bug or request a feature
- 7. License
Clone the repo:
git clone https://github.com/EuCarlos/birthday-reminder-menu-react-ts.git && cd birthday-reminder-menu-react-ts
Install the dependencies using Yarn or NPM:
yarn install // or -> npm install
Start a react server:
yarn dev // or -> npm run dev
Build the project:
yarn build // or -> npm run build
Create a web application made with React and TypeScript to notify birthdays reminders of the day.
- [FR001] - The system must count the number of people having a birthday on the day.
- [FR002] - The system must have a header with the logo on the left and a notification bell with a birthday count on the right.
- [FR003] - The system should show the message "No birthday reminders to see" after clicking the "Mark all as seen" button
- [FR004] - The system must present the name, profile picture and age in the notification.
- [NFR001] - The System must be responsive (adaptable for desktop, tablets and mobile phones).
- [NFR002] - The system must be developed using React and TypeScript.
- [NFR003] - The system must have a good interface for human-machine interaction.
Before starting, check and follow the instructions for contributing to the repository. If not, you can follow the instructions below:
- Fork the project
- Create a new branch: git checkout -b nova-branch
- Commit your changes: git commit -m 'I added something'
- Push to branch: git push origin nova-branch
- Open a Pull Request
If you want to report a bug or request a feature, go to Issue on the GitHub Project and add your request.
This project is licensed under the GNU General Public License v3.0. Read the LICENSE file for more information.
Created with 💜 by Carlos Alves