Trace

Profile management system

Simple and easy to use profile system

Installation

If you tested out our live demo and want to setup your own version then follow the steps below to install it locally or on Heroku

Note: The following guides assume you are on Ubuntu

Local

First, you need to provision a relational database so the GraphQL server can persist data.

For Trace, we used PostgreSQL, but any database supported by the sequelize package can be used like MySQL, SQLite and MSSQ.

PostgreSQL

To install PostgreSQL run

$ sudo apt install postgresql postgresql-contrib

Once installed, you need to set the password for the postgres account

$ sudo -u postgres psql postgres
$ \password postgres
$ \q

After the password is set, you need to create a database to persist data

$ sudo -u postgres psql
$ CREATE DATABASE trace;
$ \q

Client

The client was created using React and resides in the client folder. It can be run independently or served alongside the server if compiled.

Independently

To run the client independently run the following

$ cd client
$ npm install
$ npm start

This will start up the client on http://localhost:3000

Alongside the Server

To run the client alongside the server you need to compile it and then launch your server normally

$ cd client
$ npm install
$ npm run build

To access the client you will need to start up the server.

Server

To start up the server run the following

$ npm install
$ npm start

This will start up the server on http://localhost:5000 and serve what is inside the client/build folder. You will be able to access the endpoints /graphql and /graphiql from here and any other endpoint will redirect to the client/build folder which is where the compiled client will be. If you did not compile the client and instead ran it independently then accessing any endpoints other than those two will display an error in your browser.

Heroku

First, create a heroku app by using the following

$ heroku create

Provision a PostgreSQL database by running

$ heroku addons:create heroku-postgresql:hobby-dev

Deploy your copy of the app using

$ git push heroku master

Ensure at least one instance of the app is running

$ heroku ps:scale web=1

Lastly, open it in your browser using

$ heroku open

Contributors

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.

hanselrd/trace