tobiasmuecksch / openscope Goto Github PK

Visit http://openscope.co to begin playing now!

If you're just getting started, try the tutorial and see the command reference for a full list of commands you can use. For information on each airport, see the airport guide.

Feel free to join us on slack if you have questions, comments or would like to contribute to the project. We can then add you to the organization so you can begin committing to this repo.

Prerequisites: In order to successfully complete this quick start, you will need to have the following installed locally:

• Git
• Node

Installation directions are beyond the scope of this document. Instead, search the Google. Installing these two packages has been written about ad-nauseum.

From a terminal (or GitBash for Windows users), run the following commands:

1. git clone https://github.com/openscope/openscope.git
2. cd openscope
3. npm install
4. npm run build
5. npm run server

Once that finishes doing its thing, you should see something close to the following in the terminal:

> node ./public/assets/scripts/server/index.js

Listening on PORT 3003

Success!!

You you do not see this message and are having trouble getting set up, please join us on Slack and someone will be able to troubleshoot with you.

For more information on the available tools, please view the Tools Readme.

We do not use forks. Instead, we add to add all contributors to the openScope organization. This way, we can keep all branches local to the organization, and use testing integrations on pull requests. If you are interested in contributing, please message Erik Quinn or Nate Geslin on slack so you can be added to the organization.

We use the GitFlow Branching Model for managing branches. If you would like to contribute, you will be expected to use appropriate branch names based on this methodology (and we can help if you have questions).

Don't know Javascript? That's cool, we're always looking for beta testers and/or airport contributors. If you would like to add a new airport, or help update existing airports, please read the Airport Documentation to get up to speed on what is expected in that file.

MIT License

Page hits are tracked with Google Analytics.