Skip to content

Latest commit

 

History

History
138 lines (94 loc) · 3.09 KB

README.md

File metadata and controls

138 lines (94 loc) · 3.09 KB
Raw

GeoFix

GeoFix

Who has never ended up with a punctured wheel, forced to return on foot?
See the Prototype : https://geofix-4e08e.firebaseapp.com/

License

✨ The GeoFix Project

This project uses geocaching philosophy to make available fixing tools for bicycles.

The goal ? To hide and boxes with tiny and useful tools, and provide an app to retrieve and unlock them in case of need.

To discover more about Geocaching philosophy : Wikipedia

Table of contents

🚀 Quick Start

  1. Clone the project

    $ git clone https://github.com/GeoFix/GeoFix-Web.git GeoFix
$ cd GeoFix

  2. Install dependencies

    $ yarn install

  3. Configure Firebase

    $ cp .env.dist .env

    Complete informations from your Firebase Application relative to the Configuration Documentation

  4. Start your app

    $ yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

💫 Deploy

This application is provided by Firebase

  1. Install Firebase CLI

    $ npm install -g firebase-tools

  2. Login into Firebase Console

    $ firebase login

  3. Initialize Firebase Hosting

    $ firebase init

  4. Build application

    $ yarn build

  5. Deploy application

    $ firebase deploy

⚙️ Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn build

Build application in production mode into /build folder

‍💻 Authors

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for details.