Skip to content

Latest commit

 

History

History
113 lines (91 loc) · 5.79 KB

README.md

File metadata and controls

113 lines (91 loc) · 5.79 KB
Raw

the-land-conservancy

A volunteer management program to track/log hours, access volunteer information, and view available prize milestones.

Table of Contents

Overview

Purpose

The Land Conservancy of SLO works with landowners and government to care for the diverse wildlands and critical habitats of the Central Coast through conservation, restoration, and stewardship, all while connecting people to the land and one another.

The purpose of this application is to provide an application and incentive for volunteers to log hours that they have worked for The Land Conservancy. This is so that the organizers at The Lad Conservancy can easily track and report these in order to receive funding from the government and continue their work.

Team

The Land Conservancy team consists of 11 current Cal Poly students. The team members are listed below:

2022-2023 Team:

2021-2022 Team:

Getting Started for Developers

Clone the repository

git clone https://github.com/hack4impact-calpoly/the-land-conservancy.git

Download the npm packages for the frontend and backend

cd frontend
npm i
cd ../backend
npm i

Set the executable permissions for the pre-commit hook for linting

cd ..
chmod +x frontend/.husky/pre-commit
chmod +x backend/.husky/pre-commit

Set up your environmental variables

Don't forget to add the necessary .env files to your frontend and backend

Add ESLint and Prettier into your IDE

If your are using VSCode or another IDE, go to Extensions and install ESLint and Prettier. This will ensure that your code follows a standard style and will be easier for other developers to read :)
You may need to run the linting scripts in the frontend and backend folders to get the IDE to show formatting errors.
npm run lint-check
Also recommended: enable the "format on save" setting in your VSCode settings if that is your editor of choice.

Running the frontend

  • npm start (every time you pull, you might need to run npm i)

Running the backend

  • npm run dev (every time you pull, you might need to run npm i)

Get familiar with the database

Our database schemas can be found within the project files under backend/models/<schemaName>.ts

Contributing

Make sure to follow the Git Commits & Pull Requests Template

Making Changes

  1. Before you start making changes, always git pull and then npm i to make sure your code is up to date
  2. Create a branch git checkout -b <name-of-branch>
  3. Make changes to the code
  4. npm run lint-check to ensure code standards. (running npm run lint-write-all will fix most of the styling errors)

Commiting Changes

  1. git add . (to stage all files) or git add <file-name> (to stage specific file)
  2. git commit -m "<type>[optional scope]: <description>" or git commit to get a message prompt
  3. git push -u origin <name-of-branch>

Making Pull Requests

  1. Go to the Pull Requests tab
  2. Find your PR
  3. (If applicable, provide a screenshot of your work in the comment area)
  4. Link your PR to the corresponding Issue
  5. Request a reviewer to check your code
  6. Once approved, your code is ready to be merged in 🎉