Visit the website: tidy.cards
Clone the repo: git clone --recurse-submodules https://github.com/legendai-re/tidy-cards-api.git
Create a .env
file in the root directory of the project. Add
variables:
NODE_ENV=development
MONGODB_URI=mongodb://localhost:2000/dev
MONGODB_TEST_URI=mongodb://localhost:2000/test
HOST=http://localhost:8080
PORT=8080
SESSION_SECRET=my_session_secret
SESSION_NAME=localinvow
ADMIN_EMAILS=[]
IMAGES_URL=https://s3-eu-west-1.amazonaws.com/mybucketname/
IMAGES_FOLDER=dev
S3_BUCKET=my_bucket
AWS_ACCESS_KEY_ID=my_aws_id
AWS_SECRET_ACCESS_KEY=my_aws_secret
FACEBOOK_APP_ID=my_facebook_app_id
FACEBOOK_APP_SECRET=my_facebook_app_secret
TWITTER_CONSUMER_KEY=my_twitter_consumer_key
TWITTER_CONSUMER_SECRET=my_twitter_consumer_secret
GOOGLE_CLIENT_ID=my_google_client_id
GOOGLE_CLIENT_SECRET=my_google_client_secret
GOOGLE_API_KEY=my_google_api_key
ALGOLIA_API_KEY=my_algolia_api_key
ALGOLIA_API_SECRET=my_algolia_api_secret
ALGOLIA_INDEX_PREFIX=my_algolia_index_prefix
STRIPE_SECRET_KEY=my_stripe_secret
MAILER_HOST=127.0.0.1
MAILER_USER=hello@invow.xyz
MAILER_PASSWORD=mailer_password
MAILER_PORT=1025
In order to upload images you will need to install graphicsmagick
Install dependencies npm install
Start mongodb server: mongod --port=2000
Run npm run start
to start the server
Run maildev
to catch emails on port 1025. If maildev is not installed on your computer run npm install maildev -g
You can now visit the website on localhost:8080
and open localhost:1080
to see the emails send by the app.
Install mocha
globally: npm install mocha -g
. Then run npm run test
.
Install apidoc
globally: npm install apidoc -g
. Then run npm run doc
. You can now visit the api documentation on localhost:8080/api/doc
.