Skip to content

Nelson-Chinedu/volunteer-square

Repository files navigation

All Contributors All Contributors

Volunteer Sqaure (WIP)

Get volunteers without the use of using Google form in sourcing for volunteers in your event

Technologies Used

  • NextJs
  • TypeScript
  • GraphQL
  • Apollo Client
  • Rest Api

Prerequisites

The following should be installed in your machine

  • Node.Js v10.13.0

How To Install And Run The Application

  • Clone the local Volunteer-Square server from here and cd into it
  • Install the dependencies by running yarn install or npm install
  • Start the local server mode by running yarn dev
  • Clone this Repo and cd into it
  • Install the dependencies by running yarn install or npm install
  • Create a .env file with key=values in .env.sample file
  • Start the application on development mode by running yarn dev

How To Contribute

Kindly refer to the guide above to setup, and reachout to admin for further instructions

Issues

Issues are always very welcome. Please be sure to create a constructive issue when necessary.

Pull Requests

Pull request are welcome if anything is missing or something is buggy. However, there are a couple of things you can do to make life easier for the maintainers.

  • Explain the issue that your PR is solving - or link to an existing issue
  • Follow the repository structure, and new sections in the corresponding folders
  • Ask questions to admin if unclear

Releases

No releases published

Packages

No packages published