📗 Table of Contents
📖 About the Project
This is the Project phase of an 8week long bootcamp. The project is called alumni_donate.
alumni_donate is a platform that allows college organizations create a simple platform for their alumni to give back to the organization.
🛠 Tech Stack
This project was created with Visual Studio Code and the following technologies were used:
Design
Frontend
Backend
Database
API
Project Management and Version Control
🚀 Key Features
- Unauthenticated users – An individual that has not registered to the alumni platform
User can view website Home page (Landing page). This page will contain:- An alumni tab with a CTA to Login or Create Account – About Us section – FAQs section – Contact Us section – Footer section
- Authenticated Users – A user that has fully registered and has completed all the verification processes in the website
Login to the platform
Dashboard to edit profile
Create new donate page
Full access to Data
CRUD priviledge
Comment on posts
Change Password
List of Alumni
Help and Support
Log out - Donor – An individual that has been posted as a donor
💻 Product Specifications
Mobile Phones
Tablets
Laptops
⭐️ Usage
Visit the website
Surf through basic infromation
Sign up
Fill registration details
Verify email address
Proceed to KYC verification
Submit required verification documents
Get verified
Log in
Edit profile
Full CRUD priviledge
🔭 Project Status
Project is : in progress
👥 Collaboration
For TeamBadgerw2, follow the following steps to collaborate:
1] Visit the Repository to the Project on Github Website: https://github.com/zuri-training/Team-Badgerw2
2] Fork the repository: Click the “Fork” button on the upper right corner of the Repo page.*
3] Make a local clone: Click on the “Code” button on the Repo page Copy the URL for the forked Repo “https://github.com/zuri-training/Team-Badgerw2.git“
Create a Folder on your Local machine / Computer for the project Workspace Open Command prompt / Terminal in the same folder location In your Terminal, type:
git clone https://github.com/zuri-training/Team-Badgerw2.git
4] Open terminal and set upstream branch:
git remote add upstream https://github.com/zuri-training/Team-Badgerw2
5] Pull upstream to get up to date with the original repo:
git pull upstream main
6] Create a new branch for the task you are working on :
git checkout -b branchName
(Make sure your branchName is descriptive in context to the feature you are working on.
Also be sure to check which branch you are on using git status before you begin working)
When you're done with your task, do:
git add
Commit your work with a message:
git commit -m "message"
To avoid conflicts:
git pull upstream main
Then push your branch:
git push origin branchName - This creates the branch remotely and pushes to that branch on the Github
Go to Github and create a new pull request to the main branch. It will then be reviewed and merged into the master.
If you need to make an update, repeat from no 4
🤝 Contributors
Temitope Idowu (Team Lead)
Github-
Track - Product Design
Matthew Akinkunmi Olarewaju – Product Design
Boluwatife Ogunmola – Product Design
Temitope Adekunle – Product Design
Balikis Raji – Product Design
Daniella Adoga – Product Design
Akintola Daniel Fisayo – Product Design
Oluwadamilola Johnson – Product Design
Igbinoba Joshua – Product Design
Jen Ezieke – Product Design
Kehinde Oyeronke Osoba – Frontend
Prince Aguguo – Frontend
Mubarak Misbaudeen – Frontend
Beatrice Muchoki – Frontend
Batatope Eyitayo – Frontend and Nodejs
Oreoluwa Ajayi – Frontend and Nodejs
Madu Emelie – Backend and Nodejs
📝 Documentation
A more detailed documentation about the project can be found here – “documentationLinkWhenReady”
Hosting Link
https://teambadgerw2.onrender.com/
🙏 Acknowledgments
This project is acknowlegded to Zuri Team for creating this organization and bringing about this project. Special thanks to the sponsors too.