mcyph / unihack_2021_park_earn

React Spectre.css Kickstarter

In a similar spirit to the docs at https://github.com/sahat/hackathon-starter and https://www.thecodeship.com/general/hackathon-toolbox-essential-tools-practices/, this repo contains a bunch of components based on the CSS UI framework spectre.css which allows quickly building functional applications with rich UI components, charts and map visualizations for the purpose of civic tech, hackathons and many other kinds of projects.

View the demo:

>> https://mcyph.github.io/react_spectrecss_kickstarter/ <<

This project is light on docs at the moment but there are functional examples at the above link and plan to get a more detailed tutorial up soon.

Quickstart

1. node.js for your operating system: https://nodejs.org/en/download/

2. Fork this repository using the GitHub link in the top right

3. Open a console window, then type:

   git clone https://github.com/[my user name here]/react_spectrecss_kickstarter.git
   cd react_spectrecss_kickstarter
   

4. To install node.js dependencies, type:

   npm install
   

5. Then, to run the server, type the following from Windows from a command prompt:

   npm start
   

   and browse to the address http://localhost:3000 with a web browser for the demo once things are done!

NB: After adding new packages to package.json, remember to type:

npm install

License

Copyright 2021 David Morrissey

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.