-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
7f8e02d
commit 992b5a5
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# colonyServer | ||
|
||
GraphQL-powered metadata server for colonies, with on-chain authentication via the [Colony Network](https://github.com/JoinColony/colonyNetwork). | ||
|
||
|
||
## Prerequisites | ||
|
||
* `mongod` >=3.6 | ||
* `solc` >=0.5.8 (we recommend via Docker) | ||
|
||
|
||
## Setup | ||
|
||
```bash | ||
# Set up colonyNetwork submodule | ||
git submodule update --init --recursive | ||
cd lib/colonyNetwork | ||
npm install | ||
npm run provision:token:contracts | ||
cd ../.. | ||
|
||
# Copy .env.example (make changes where appropriate) | ||
cp .env.example .env | ||
|
||
# Set up colonyServer, create the database and start the server | ||
npm install | ||
# If necessary, start mongod: | ||
# npm run db:start | ||
npm run db:setup | ||
npm run dev | ||
|
||
# For authentication, compile and migrate colonyNetwork contracts | ||
cd lib/colonyNetwork | ||
npm run start:blockchain:client | ||
npx truffle migrate --reset --compile-all | ||
``` |