Animali

Animali is a data collection platform for endangered and at-risk species across the globe.
Explore the docs »

View Site · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

Built With

• Vue
• Nuxt
• Tailwind
• Firebase
• Algolia

Getting Started

To get a local copy up and running follow these steps...

Prerequisites

• npm or yarn
• Google Cloud Platform account
• Firebase account
• Algolia account

Installation

1. Clone the repo

   git clone https://github.com/pjmanning/animali-web-app.git

2. Install NPM packages

   yarn install

3. Set up Firebase project

4. Define .env file with firebase config

5. Set up Google Maps

6. Set up Algolia

7. Run on local environment

   yarn dev

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU GENERAL PUBLIC LICENSE. See LICENSE for more information.

Contact

PJ Manning - @pj_manning - [email protected]

Project Link: https://github.com/pjmanning/animali-web-app

Acknowledgements

• Vue
• Nuxt
• Tailwind
• Firebase
• Algolia