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.
- npm v3+ & node v4+
- Codefolio API
- Modern browser ie. Chrome, FF, Safari, IE10+, iOS, Android
- Clone this repo with
git clone https://github.com/msmfsd/codefolio.git - Open directory
- Run
npm install - Remove existing git directory with
rm -rf .git - Make your own .git with
git init
- Open the root file config.js
- Follow the instructions carefully in the comments of the file
- Ensure your local Codefolio API server is configured and running
- Run
npm run startcommand - Open browser at http://localhost:3000/
- Create your administrator at http://localhost:3000/register
- Login and start editing your folio using the CMS at http://localhost:3000/admin
- Ensure the config.js file has your correct API_PROD_URL
- Run
npm run buildcommand - Follow the Codefolio + Codefolio API Guide to publish your folio to a production server
- Feel free to customize the source code to suit your needs
- View Codefolio Documentation
- I recommend you install Redux Devtools extension to your browser
- NOTE: In development environment the admin forms will output React Unknown props warnings in the browser inspector console, they are caused by current stable ReduxForm/React versions. These do not effect the application, can be ignored and will not appear in your production bundle.
Feel free to open an issue or post a pull request
MIT License