Skip to content

Latest commit

 

History

History
166 lines (115 loc) · 6.14 KB

README.md

File metadata and controls

166 lines (115 loc) · 6.14 KB
Raw

Furgetmenot: Adopt, Rescue, Love until the end of time!

Vue version Vue version Netlify Status

About

Do you value your pet like a family member? You do, of course. That is why you are here! And we are delighted that you've chosen us!

You can meet your next best friend and save a pet through animal adoption. Last year over 6,000,000 dogs & cats were killed on US roads. Countless variety of animals have got injured on the road worldwide, and are struggling to survive every single day. So this is the major reason we are here for them. We are a community of animal lovers and pet advocates. We aim to provide everybody with exposure at reasonable rates to good quality, natural remedies.

Sharing your life with a pet may be a rewarding activity, but it also requires taking control of your capabilities for life. The ownership of a pet has so many benefits. If you have this partner everywhere you are, your social life would boost, keep you healthy, involved and without tension. When you love a companion you feel better. Taking care of a pet can provide a sense of purpose and fulfillment, and even lessen the loneliness of all age groups. With an active dog, you can go out for a walk, or even go to a dog park to get to know people. Research suggests that the development of the stress hormone can be decreased by petting a dog. Your pet will always be there for you, so you would never be afraid. Along with psychological, mental and physical rewards, animals deliver unconditional affection.

We see you as part of our extended family as you are a member of FurgetMeNot.

Set up

Requirements

Local development

After the above requirements have been met:

1. Clone this repository and cd into it

git clone https://github.com/Iconicto/furgetmenot.git
cd furgetmenot

2. Install dependencies

npm install

3. Setup Firebase Project

Goto your Firebase Console and create a new project in Firebase Console. Then register a new web app. Copy the config data from the config file which will look like this.

apiKey: "firebase-api-key",
authDomain: "firebase-auth-domain",
databaseURL: "firebase-db-url",
projectId: "firebase-project-id",
storageBucket: "firebase-storage-bucket",
messagingSenderId: "firebase-messaging-id",
appId: "firebase-app-id"

4. Setup Firebase Configuration

Rename the sample.env.txt file into .env and add your previously copied Firebase configuration details there. (Replace the ###### marks with relevant details.)

5. Setup Firebase Realtime Database

Goto Database section in your Firebase Console and create a Realtime Database. Import database.json file in the src folder into Firebase Database. It will create dummy data for you to test.

7. Run the project 

npm run serve

Contributing

This project is open source and welcomes contributions.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.

  2. Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.

  3. Isolate the problem — make sure that the code in the repository is definitely responsible for the issue.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the Roots developers of the merits of this feature. Please provide as much detail and context as possible.

Feature requests

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the developers might not want to merge into the project.

Please adhere to the coding conventions used throughout the project (indentation, comments, etc.).

If you want to work on an existing issue, please leave a comment so we can assign the task to you.

Contributors

Suvin Nimnaka
Suvin Nimnaka
 Sewvandi Promodya
Sewvandi Promodya 		Manakal Muthukumara
Manakal Muthukumara

License

MIT

Disclaimer

No warranty expressed or implied. Software is as is.