Skip to content

A Node.js website boilerplate that satisfies some common website requirements.

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.txt
Notifications You must be signed in to change notification settings

neilospricey/nodejs-website-boilerplate

 
 

Repository files navigation

Node.js Website Boilerplate

A website template that satisfies some common website requirements including dynamic pages, blog articles, author management, SEO ability, contact form and website search. Content powered by Cosmic JS. Contributions welcome!

Demo

Click here to view a demo website (Medical Professional)

Features

  1. Fully responsive down to mobile w/ Bootstrap frontend
  2. SEO ready
  3. A contact form that sends an email to your email(s) of choice and to Cosmic JS for easy reference
  4. Full-site search functionality
  5. All content is easily managed in Cosmic JS including pages, blog and contact info.

Sign up for Cosmic JS to install the demo content and deploy this website.

Get started

git clone https://github.com/cosmicjs/nodejs-website-boilerplate
cd nodejs-website-boilerplate
npm install

Import the bucket.json file into your Cosmic JS Bucket. To do this go to Your Bucket > Settings > Import / Export Data.

Run in production

COSMIC_BUCKET=your-bucket-slug npm start

Go to http://localhost:3000.

Run in development

Create a config/development.js file and match it to config/production.js with your values.

npm run development

Go to http://localhost:5000.

Contact form setup

Install and deploy the SendGrid Email Function.

The contact form on the contact page uses the SendGrid Email Function to send emails. To deploy your email function go to Your Bucket > Settings > Functions. Install and deploy the SendGrid Function. You will need an account with SendGrid to add your SendGrid API key.

Add the SendGrid Function Endpoint

in development

Go to config/development.js and edit SENDGRID_FUNCTION_ENDPOINT to manually add the URL for testing.

in production

If you are using the Web Hosting option that's included with every Bucket:

  1. Go to Your Bucket > Settings > Web Hosting
  2. Deploy your Website
  3. Click 'Set Environment Variables' tab and add the SendGrid Function endpoint:
Key Value
SENDGRID_FUNCTION_ENDPOINT https://your-lambda-endpoint.amazonaws.com/dev/send-email

About

A Node.js website boilerplate that satisfies some common website requirements.

Resources

License

MIT, Unknown licenses found

Licenses found

MIT
LICENSE
Unknown
LICENSE.txt

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 76.1%
  • JavaScript 17.2%
  • HTML 6.7%