Personal Portfolio website built in Node.js using the Stimulus Template
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
In order to run this site on your local machine all what you need to do is to have the prerequisites stated below installed on your machine and follow the installation steps down below.
- Node.js
- Yarn or NPM
- Git
Start by typing the following commands in your terminal in order to get Adminator full package on your machine and starting a local development server with live reload feature.
> git clone https://github.com/roydenrego/roydenrego.com.git roydenrego
> cd roydenrego
> npm install
Create a .env file in the root of the project whose contents should be as below:
DB_CONN="DATABASE_CONNECTION_STRING_HERE"
SENDGRID_API_KEY="SENDGRID_API_KEY_HERE"
AWS_ACCESS_KEY="FILL_HERE"
AWS_SECRET_ACCESS_KEY="TO_BE_FILLED"
SESS_SECRET="ANY_RANDOM_STRING_OF_YOUR_CHOICE"
CLIENT_EMAIL="ANALYTICS_CLIENT_EMAIL"
PRIVATE_KEY="ANALYTICS_PRIVATE_KEY"
TEST_ACC_EMAIL="TEST_ACCOUNT_EMAIL"
TEST_ACC_PASSWORD="TEST_ACCOUNT_PASSWORD"
You need to replace the placeholders with actual API Keys which can be obtained from the appropriate vendors.
Test email and password is only required if you are running unit tests. Simply insert the any sample email and password to the database as per the Scheme and you should be good to go.
Once the .env file is setup, you can run the website by executing the following command:
> npm start
- Stimulus Template: http://www.templatemo.com/tm-498-stimulus
- News Cards: https://codepen.io/choogoor/pen/YWBxAg
- SRTdash: https://github.com/puikinsh/srtdash-admin-dashboard
Initial Release
roydenrego.com is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the final products. But you always need to state that Royden Rego is the original author of this template. See LICENSE for more information.