mirror of
https://github.com/unitehenry/chaotic-api.git
synced 2026-03-21 17:44:38 -05:00
init repo
This commit is contained in:
parent
fe9089037f
commit
408e21691b
7
LICENSE.txt
Normal file
7
LICENSE.txt
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
Copyright 2020 Henry Unite
|
||||
|
||||
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.
|
||||
33
README.md
Normal file
33
README.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Chaotic Trading Card Game API
|
||||
|
||||
A repository of Chaotic Trading Card Game assets and out-of-the-box api solution for aggregating card data.
|
||||
|
||||
## Getting Started
|
||||
|
||||
To set up the API, begin by cloning the repository and installing dependencies.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/unitehenry/chaotic-api
|
||||
|
||||
$ cd chaotic-api
|
||||
|
||||
$ npm install
|
||||
```
|
||||
|
||||
## Importing Data
|
||||
|
||||
This API uses MongoDB to store card data. Create an environment variable ```DATABASE_URL``` and add the url to the mongoDB server. Then run the import script.
|
||||
|
||||
```sh
|
||||
$ echo "DATABASE_URL=mongodb://localhost/chaotic" > .env
|
||||
|
||||
$ npm run import
|
||||
```
|
||||
|
||||
## Starting the Server
|
||||
|
||||
After the card data has been imported, you can begin serving data with the API server.
|
||||
|
||||
```sh
|
||||
$ npm run serve
|
||||
```
|
||||
Loading…
Reference in New Issue
Block a user