Rusty Snake

Rusty is a battle snake built with Rocket, a rust web developement framework.

Note:

If you just want to use this as the starter snake run this command in the directory.

git checkout template

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to use and develope Rusty your going to need a few things:

Installing

Once your done with the basics copy and paste the command below into your terminal:

git clone https://github.com/McRaeAlex/RustySnake.git

Then

cd RustySnake
git checkout template
cargo run

You should see something like this

Configured for development.
    => address: localhost
    => port: 8000
    => log: normal
    => workers: 8
    => secret key: generated
    => limits: forms = 32KiB
    => tls: disabled
🛰  Mounting '/':
    => GET /
    => POST /start
🚀  Rocket has launched from http://localhost:8000

if you don't and it gives you errors saying missing features or something about nightly, run:

rustup default nightly

to switch your default toolchain to nightly

to install nightly

rustup install nightly

To push it to your own repo

git push -u <your repo>

And your done!

Running the tests:

Using the package manager bundled with rust run:

cargo test

Deployment (TODO)

Add additional notes about how to deploy this on a live system

Built With

Rust - The programming language used
Rocket - The web framework used
Serde - Used to serialize and deserialize json

Contributing

This is more of a personal project than anything. However if you would like to contribute shoot me a email: alex@alexandermcrae.com

Authors

Alexander McRae - Everything so far - Alex McRae

License

MIT License

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.

ahendy/RustySnake