search

cornellh4i / lagos-volunteers

Lagos Food Bank Volunteer Management System
https://lagos-volunteers.vercel.app
MIT License
13 stars 6 forks source link

readme


Logo

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
  2. Getting Started

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

Installation

  1. Install Docker

  2. Install Dev Containers

  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

Spring 2024

Fall 2023

Spring 2023