Skip to content

arc-pune/arc-front-end

Repository files navigation

ARC(Animal Rescue Community)

Raising Hands For Injured Paws

Animal Rescue Community (ARC) Pune is a group of college students raising hands for injured paws since 2020. We are a non-profit community organization of around 60 active volunteers, and many passive volunteers all over pune.

Feeding, Rescue and Adoptions are our main domain of work. Our volunteers daily feed 500+ dogs and cats in their respective areas. Adoption is our prominent feature. We have been a part of 225+ successful adoptions till date. We also take rescue cases enthusiastically.

We believe in coexistence and work for reducing human-animal conflicts.

Contents

Stack

Stack Technology
Frontend React.js
Component Library tailwindcss , material-ui
Backend Nodejs , expressjs
Database MongoDB

Figma

Figma Design Check design folder for the png of the same..

NPM NODE License

Setup Guide

Basic requirements

 Install Node version 14 or higher
  • Fork this repository into your own GitHub account.

  • Clone the repo from your GitHub account to your local machine using the following commands

  • you can either use ssh or https

using https:
$ git clone https://github.com/arc-pune/arc-front-end.git
$ cd arc-front-end

or

using ssh:
$ git clone git@github.com:arc-pune/arc-front-end.git
$ cd arc-front-end
  • Creating branch
git branch  your-branch-name
git checkout your-branch-name

To run the development server, do the following in the arc-frontend directory:

Non-Docker Version

$ npm install
$ npm start

It might take a while until craco is up and running.

Docker Version

$ npm run install && npm dockerize

You can now see the project running on your localhost

You can edit files on your text-editor, changes will be reflected in your browser.

Contributing Guide

  • Go to Contributing.md

Community

We also have public chat rooms on Discord. Feel free to connect!

Support

If you have any feature requests or bug reports, please log them on the issue tracker.

License

This project is licensed under the MIT License.

Primary maintainers

Anand

Kishore

Sahil