neoskx / campsitesworker

Provide service to query and monitor campsites, when it is available notify you

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Campsites Worker

Campsites Worker

Work Smart, Do More

Campsites Worker solve following requirement:

  1. Find available Campsites in specify weekday. When I want to camping with my friends, first thing need to do is booking Campsite.
  2. When in wish list campsites are available, I want to be notified. Most of time when I want to book a campsites it already was booked, but some people maybe cancel it, when this is happen, I want to be notified, so I can book it

Currently, it is only monitor reservecalifornia.com and reserveamerica.com

Installing / Getting started

Based on React Starter Kit.

Developing

Built With

List main libraries, frameworks used including versions (React, Angular etc...)

Prerequisites

What is needed to set up the dev environment. For instance, global dependencies or any other tools. include download links.

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/shaoke/campsitesworker
cd your-project/
packagemanager install

And state what happens step-by-step. If there is any virtual environment, local server or database feeder needed, explain here.

Building

If your project needs some additional steps for the developer to build the project after some code changes, state them here. for example:

./configure
make
make install

Here again you should state what actually happens when the code above gets executed.

Deploying / Publishing

give instructions on how to build and release a new version In case there's some step you have to take that publishes this project to a server, this is the right time to state it.

packagemanager deploy your-project -s server.com -u username -p password

And again you'd need to tell what the previous code actually does.

Versioning

We can maybe use SemVer for versioning. For the versions available, see the link to tags on this repository.

Configuration

Here you should write what are all of the configurations a user can enter when using the project.

Tests

Describe and show how to run the tests with code examples. Explain what these tests test and why.

Give an example

Style guide

Read React Style Guide to get more information

API Reference

You can take a look RESTFul API in openapi.json. You also can view online version - openapi.json

Database

Explaining what database (and version) has been used. Provide download links. Documents your database design and schemas, relations etc...

Licensing

MIT

About

Provide service to query and monitor campsites, when it is available notify you

License:MIT License


Languages

Language:JavaScript 83.7%Language:CSS 16.3%