Lagos Food Bank Initiative

Lagos Food Bank Initiative is a non-profit organization that aims to reduce food waste and hunger in Lagos, Nigeria.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation

About the Project

This project aims to develop a volunteer management system for Lagos Food Bank Initiative. The system will allow volunteers to sign up for shifts, and for LFBI to manage volunteers and hours.

Built With

• 
• 
• 
• 

Getting Started

Folder structure

.
├── frontend      # Next.js client
├── backend       # Express server
└── README.md

Prerequisites

• Nodejs
• PostreSQL
• Docker

Installation

1. Install Docker

   • Install Docker Desktop for macOS
   • Install Docker Desktop for Windows

2. Install Dev Containers

   • In VS Code, install the Dev Containers extension

3. Clone the Git repository

   git clone https://github.com/cornellh4i/lagos-volunteers.git

4. Open the repository in VS Code. A button should appear in the bottom right corner asking to reopen the folder in a Dev Container. Click Yes.

5. Add necessary environment variables. In the backend folder, create a copy of .env.template and rename it as .env. In the frontend folder, create a copy of .env.template and rename is as .env.local. Fill out all the necessary details. Note that .env files should never be committed to GitHub.

6. Start the client and server

   # Run yarn setup in the root folder to build both the backend and the frontend
   yarn setup
   
   # Run yarn start in the root folder to start both the backend and the frontend
   yarn start
   
   # Run yarn test in the root folder to run Jest tests for the backend
   yarn test

Note: See individual project files for more information on how to build and deploy the project.

Contributors

Fall 2024

• Akinfolami Akin-Alamu
• Jason Zheng

Spring 2024

• Leads
  • Akinfolami Akin-Alamu
  • Jason Zheng
• Developers
  • Arushi Aggarwal
  • Owen Chen
  • Hubert He
  • Trung-Nghia Le
  • Brandon Lerit
  • Diego Marques
  • Tanvi Mavani
  • David Valarezo

Fall 2023

• Leads
  • Akinfolami Akin-Alamu
  • Jason Zheng
• Developers
  • Sneha Rajaraman
  • Daniel Thorne
  • Louis Valencia
  • Sophie Wang
  • Yichen Yao
  • Hannah Zhang
• Designers
  • Ella Keen Allee
  • Bella Besuud
  • Mika Labadan

Spring 2023

• Leads
  • Akinfolami Akin-Alamu
  • Jason Zheng
• Developers
  • Jiayi Bai
  • Daniel Botros
  • Sneha Rajaraman
  • Sophie Wang
  • Yichen Yao
  • Hannah Zhang
• Designers
  • Bella Besuud
  • Mika Labadan
  • Julia Papp