api.fuelrats.com
Setting up
So, first of you need to fetch a few things and install. These should be available as packages from you favorite package manager.
Grab the repo:
git clone https://github.com/FuelRats/api.fuelrats.com.git
Install all of the required Node modules:
cd api.fuelrats.com
npm install webpack@^2.1.0-beta
npm install -g grunt-cli
npm install
Make sure that you have created the databases required:
su postgres
psql -c 'CREATE DATABASE fuelrats;' -U postgres
psql -c 'CREATE DATABASE fuelratsTest;' -U postgres
psql -c 'CREATE USER fuelrats;' -U postgres
psql -c "ALTER USER fuelrats PASSWORD 'fuelrats';" -U postgres
exit
And if you want to use a different username or password, you can use them instead and set the new ones in your config.json
Now start the server!
npm run dev
This will ensure that Postgres is running as a service and start the API itself on either port 8080 or whatever port you've set in config.json.
Common Problems
"Missing indexes" or an empty object is returned
Your databases are empty, home slice. You can use our import script to grab a bunch of archived FuelRats data.
Development
To work for realsies you need to copy the config-example.json file and update any settings you need changed:
cp config-example.json config.json
The npm run dev task starts the API and will automatically restart it when you change a file. Simply kill the process when you're done. Good luck, and may the force be with you.
Generating the docs
It's so easy a DerryBear could do it! Just run the generator script:
node bin/compile-docs.js
License
Copyright 2017 The Fuel Rats Mischief
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.