- JavaScript 61.9%
- HTML 19.8%
- Less 11.2%
- CSS 6.5%
- EJS 0.6%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| api | ||
| client | ||
| config | ||
| test | ||
| .babelrc | ||
| .editorconfig | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitattributes | ||
| .gitignore | ||
| .sailsrc | ||
| .travis.yml | ||
| app.js | ||
| CONTRIBUTING.md | ||
| karma.conf.js | ||
| LICENSE.md | ||
| package.json | ||
| README.md | ||
porybox
Porybox is a platform that allows users to manage their Pokémon to easily display their collections and make more informed trade decisions.
Usage
Installation
Make sure you have Node 6+ installed.
git clone https://github.com/porybox/porybox.git
cd porybox
npm install
Setting up a local database
To run Porybox locally, you will need to connect to a MongoDB instance somewhere. This section will walk you through how to set up a local MongoDB instance. You can skip the first two steps if you plan to connect to a remote MongoDB instance.
- Follow the instructions here to install MongoDB.
- Run
sudo mongodin another terminal window.
To enter private config information (a remote database URL, or a database password):
cp config/local.example.js config/local.js
# (enter your config information into config/local.js)
Running Porybox
Once you have a database running, use npm start to run Porybox on a local server. You can now interact with it by going to http://localhost:1337.
To run the unit tests, use npm test.
Contributing
We welcome code changes, issue raising and help with documentation, but please remember to read the CONTRIBUTING.md file initially.