Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2.02 KB

README.md

File metadata and controls

40 lines (30 loc) · 2.02 KB
Raw

Codefolio API Build Status

Codefolio project is an open source build-your-own folio website & CMS for developers to showcase their skills and work. See the Codefolio + Codefolio API Guide as the first point of reference.

Codefolio & Codefolio API are seperate projects that connect with each other to create your developer folio. Codefolio is the static front-end website & CMS that displays your folio to the public and allows you to manage it's content. Codefolio API is a RESTful API server that performs CRUD operations on data requested by your Codefolio site.

Demo

Requirements

  • npm v3+ & node v4+
  • MongoDB v2.6.5+
  • Codefolio
  • To enable forgot password functionality you will need a free Sendgrid account, take note of your username and password

Getting started

  1. Clone this repo with git clone https://github.com/msmfsd/codefolio-api.git
  2. Open directory
  3. Run npm install
  4. Remove existing git directory with rm -rf .git
  5. Make your own .git with git init

Node ENV Configuration

  1. Copy the .env.example file in the root directory and rename it to .env
  2. Follow the instructions carefully in the comments of the file

Start dev server

  1. Run mongod command in a separate terminal window
  2. Run npm run dev command
  3. Use Postman or a browser to test your API works @ http://localhost:8080/
  4. Install Codefolio locally to connect to the API and build your folio

Deploy API to production server

  1. Follow the Codefolio + Codefolio API Guide

Contributing

Feel free to open an issue or post a pull request

License

MIT License