niloysikdar / remembirth

Do you always forget everyone's Birthday and miss to wish them? Don't worry, the solution is here.

RememBirth

One stop solution to remember everone's birthday and get the daily updates about them.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contributors

About The Project

Do you always forget everyone's Birthday and miss to wish them? Don't worry, the solution is here.
RememBirth is the one stop solution to remember everone's birthday and get the daily updates about them.

Built With

• React
• TypeScript
• Sass

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

We strictly use yarn for managing the packages/dependencies. You need to install yarn to successfully run this project locally.

• yarn

  npm install -g yarn

Installation

1. Fork the project first

2. Clone the forked repo

   git clone https://github.com/your_name/RememBirth.git

3. In the project directory, install the packages using

   yarn

   or

   yarn install

4. Run the app in the development mode using

   yarn start

   Open http://localhost:3000 to view it in the browser. The page will reload if you make edits.
   You will also see any lint errors in the console.

Roadmap

See the open issues for a list of proposed features (and known issues). Feel free to raise new issues.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch ( git checkout -b feature/AmazingFeature )
3. Add your Changes ( git add . )
4. Commit your Changes ( git commit -m 'Add some AmazingFeature' )
5. Push to the Branch ( git push origin feature/AmazingFeature )
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contributors

Thanks to these wonderful people ✨✨:

remembirth's Issues

Add New Data

🚀 Feature

Add New Data to the project

Describe the solution you'd like

• Go to public/data/json/ directory and you will find some files named ${Name}.json.
• Copy the content of any file, create a new file named ${yourName}.json and paste the content and change them according to your own.
• Use this website to upload your photo and add the CDN link to ${yourName}.json file

Additional context

• Please don't add irrelevant and false content
• Use proper mentioned keys for the data, violating the structure will cause not merging and approving your pull request.

Sample ${yourName}.json file structure

{
  "name": "Niloy Sikdar",
  "birthDate": "30/07",
  "imageURL": "https://i.imgur.com/LQF21TP.png",
  "gitHubURL": "https://github.com/niloysikdar",
  "linkedInURL": "https://www.linkedin.com/in/niloysikdar/",
  "twitterURL": "https://twitter.com/niloysikdar_"
}

Update the Info Modal

🚀 Feature

A clear and concise description of what the feature is.
Currently the info modal only has lorem ipsum text. Also, the styling isn't looking good.

Describe the solution you'd like
Change the content with some actual content that describes the project. Also, add some proper styling using scss modules by editing the .scss file.

Additional context
Find the component here: src/components/About/
Edit the index.tsx and style.module.scss files.

Adding a search feature

🚀 Feature

A clear and concise description of what the feature is.

We can add a search box so that users can search for any particular profile and we need to render the data according to the search query.

Describe the solution you'd like

Need to add a search bar at the top, also need to add some logic to filter out the data according to the search query.

Additional context

Please add a new component in the src/components/ directory and add the Search Bar component.

Making the Navbar Responsive

Describe the Bug 🐛

A clear and concise description of what the bug is
Currently, the Navbar isn't responsive properly. If you open it on small screens, you will find some issues with the toggle buttons.

Expected behavior
The Navbar and Toggle Buttons should be responsive for the screens.

Screenshots

Smartphone (please complete the following information):

• Device: any
• OS: any
• Browser: any
• Version: any