generated from 202306-NEA-DZ-FEW/capstone-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #133 from 202306-NEA-DZ-FEW/develop
V1.0 Stable
- Loading branch information
Showing
8 changed files
with
221 additions
and
118 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,99 @@ | ||
# Capstone project information | ||
# AideBeAide - Uniting Hearts, Creating Change | ||
|
||
## Project information | ||
## About AideBeAide | ||
|
||
- Project name: Team-Nine Pebble Work Theme | ||
- Project description: Volunteering Website, for searinching and creating events | ||
- Technology used: Nextjs, TailwindCSS, i18next, Husky, Prettier, Eslint, Commitlinter (Conventional Commits) | ||
- Team members: hachem bouhadede | ||
Khalil NOUI | ||
Oualid Elhouari | ||
imane omari | ||
Imad Eddine KETTAF | ||
- Bootcamp: DZ NEA FEW 2023 | ||
Welcome to 'Aide be Aide', where we unite hearts and hands to make a difference. Our charity events are more than gatherings; they're opportunities to transform lives. Join our mission to inspire hope, foster change, and spread kindness. Together, we can create a brighter future, one event at a time | ||
|
||
## Installation | ||
Deployed website: [AideBeAide](https://aidebeaide.vercel.app/) | ||
|
||
```shell | ||
npm install -g commitizen // Installs commitizen | ||
npx husky install // Installs Husky | ||
chmod ug+x .husky/* // Gives husky executable extension | ||
npm install // Installs the node modules | ||
``` | ||
## Project Overview | ||
|
||
## Development process | ||
AideBeAide is born out of a shared belief that everyone can make a difference. This project aims to break down barriers to volunteering, providing a seamless platform for organizers and volunteers to come together, collaborate, and create change. | ||
|
||
- When commiting you will have to use `git cz` and then go through the process. Look at the first commit I made to know what that means. | ||
- The translation process is done using the i18next library. There's an example in the index.js file of how this is done. Check this github project for more info on how to use the i18next library: [i18next](https://github.com/i18next/next-i18next) | ||
- When writing commits, commitlinter library is used to make sure that your commits are consistent with the conventional commits. To learn more about it refer to the guidelines in Canvas or the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) site. | ||
- The `layout` folder contains the components that will be used in the layout of pages, so components like the header and footer will be placed there. | ||
## Core Components | ||
|
||
Good luck and happy coding :D | ||
- **Connection Hub:** Schedule and participate in volunteering events seamlessly. | ||
|
||
- **Targeted Engagement:** Intuitive Login/Signup, Authentication, Google, and Facebook Integration. | ||
|
||
- **Personal Haven:** Customize your profile and share your volunteering journey. | ||
|
||
- **Global Connectivity:** Break language barriers with our double-language support. | ||
|
||
- **Impactful Interaction:** Engage through Comments, And reactions on each of our events. | ||
|
||
## Pages | ||
|
||
- **Home Page:** A warm introduction to the platform and featured volunteering opportunities. | ||
|
||
- **About Page:** Learn about our mission, the team behind AideBeAide, and our commitment to social impact. | ||
|
||
- **Authentication Page:** Securely log in or sign up to start your volunteering journey. | ||
|
||
- **events Page:** A central hub for insightful, inspiring set of upcoming events, and resources related to volunteering and social causes. | ||
|
||
- **User Profile Page:** Your personalized space to showcase your volunteering achievements and manage your information. | ||
|
||
- **Event Booking, creating and editing Page:** Schedule and manage your participation in upcoming volunteering events. | ||
|
||
- **Payment Page (via Stripe):** Support your favorite causes through secure and hassle-free transactions. | ||
|
||
## Project Management | ||
|
||
- **GitHub Issues: Agile Task Management** | ||
|
||
Create, discuss, and assign tasks efficiently within a collaborative environment. | ||
|
||
- **Milestones: Strategic Progress Tracking** | ||
Organize Group related issues, tasks, and features into milestones to create a strategic roadmap. Track progress seamlessly, set deadlines, and celebrate achievements. | ||
|
||
- **GitHub Project Management Tool: Kanban Boards for Workflow Mastery** | ||
|
||
Visualize workflow, allow to move tasks through custom-defined stages. From "To-Do" to "Completed," provide a clear snapshot of the project's status and enable effective task prioritization. | ||
|
||
- **Mind Map: Visualizing Project Structure** | ||
|
||
visualize project structure and relationships. ensure a holistic approach to the project planning and execution. | ||
|
||
- **Communication and Collaboration** | ||
|
||
Centralize communication and collaboration efforts by seamlessly integrating GitHub Issues, Discord, Google Meet, and Google Calendar. | ||
|
||
## Usage Examples | ||
|
||
Visit our [Wiki](./wiki.md) for detailed examples on how to get the most out of AideBeAide, from signing up to scheduling your first event. | ||
|
||
## Screenshots | ||
|
||
![AideBeAide Screenshots](./screenshot.png) | ||
|
||
## Changelog | ||
|
||
Check out our [Changelog](./CHANGELOG.md) to stay updated on the latest features, improvements, and bug fixes. | ||
|
||
## Acknowledgments | ||
|
||
- Special thanks to [Re:Coded](https://www.re-coded.com/) for inspiring our collaborative spirit. | ||
- Thanks to our amazing mentors: | ||
Salah | Re:Coded | ||
Menar | Re:Coded | ||
Hiba | Re:Coded | ||
Meriem | Re:Coded | ||
|
||
## 🔧 Tools | ||
|
||
- [Next.js](https://nextjs.org/): For a smooth and responsive user interface. | ||
- [Tailwind CSS](https://tailwindcss.com/): Keeping things simple, yet stylish. | ||
- [i18next](https://www.i18next.com/): Breaking language barriers for a global community. | ||
- [Husky, Prettier, ESLint, Commitlinter](https://github.com/AideBeAide/AideBeAide/blob/main/.huskyrc): Ensuring clean and consistent code. | ||
|
||
## 🌐 Contact US | ||
|
||
For questions or just to say hello, reach out to us: | ||
|
||
- [Hachem Bouhadede](https://github.com/HachemBouhadede) | ||
- [Oualid ElHouari](https://github.com/oualidelh) | ||
- [Iman Omari](https://github.com/iman-om) | ||
- [Khalil NOUI](https://github.com/Khalil-NOUI) | ||
|
||
Let's build a community where every act of volunteering carries a message of hope. Join us at AideBeAide and let's make the world a better place together. 🌟 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.