hirako2000 / hirako-bird-collection

A parallax bird collection explorer
GNU General Public License v2.0
2 stars 0 forks source link

Contributors Forks Stargazers Issues MIT License


Logo

Bird Collection

A collection of birds about to morph geospatial
Explore the idea »

View Current State :: Report Bug :: Request Feature

Table of Contents
  1. idea
  2. Getting Started
  3. size stats
  4. Roadmap
  5. Contributing
  6. License
  7. Acknowledgments

About The Project

Product Name Screen Shot

There are many datasets out there, but another project is granted to exlpore them

Here's why:

Of course, no one UX is perfect, this project has as ambition to be unique, and raise that bar to make large data sets exploration less frustrating, and more engaging.

(back to top)

Built With

Major frameworks/libraries used to bootstrap your project.

More to come.

Getting Started

You will need nodejs v14+ & npm installed to proceed with setting up the project locally.

Prerequisites

Git clone/checkout this repo, then install npm dependencies:

npm install

Dev server

The project comes with a script to start the dev server. It keeps watching for changes and will automatically refresh the browser.

  npm run dev

Build

And a script is there to build for production with minified assets.

The project comes with a script to start the dev server. It keeps watching for changes and will automatically refresh the browser.

  npm run build

It generates the built files in the ./dist folder.

(back to top)

Asset size stats

asset size gziped
index.html 3.8 kB 2.1 kB
styles.css 9.1K 4.5 kB
script.js 8.3 kB 3.5 kB

Roadmap

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

Distributed under an open source license. See LICENSE.txt for more information.

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!