Git Product home page Git Product logo

codefolio's Introduction

Codefolio 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+
  • Codefolio API
  • Modern browser ie. Chrome, FF, Safari, IE10+, iOS, Android

Getting started

  1. Clone this repo with git clone https://github.com/msmfsd/codefolio.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

Configuration

  1. Open the root file config.js
  2. Follow the instructions carefully in the comments of the file

Start dev server

  1. Ensure your local Codefolio API server is configured and running
  2. Run npm run start command
  3. Open browser at http://localhost:3000/

Edit content using the CMS

  1. Create your administrator at http://localhost:3000/register
  2. Login and start editing your folio using the CMS at http://localhost:3000/admin

Build production bundle

  1. Ensure the config.js file has your correct API_PROD_URL
  2. Run npm run build command
  3. Follow the Codefolio + Codefolio API Guide to publish your folio to a production server

Customize

  • 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.

Contributing

Feel free to open an issue or post a pull request

License

MIT License

codefolio's People

Contributors

msmfsd avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

gnagel

codefolio's Issues

Resolve external config

Need to resolve external config loading for production build. Preferable its a secure external file loaded at runtime and not bundled into the js code. Use fetch from frontend if you have to.
ALSO CHANGE TO 1 config.js file:
module.exports = { development: { isProduction: false, domain: localhost, port: 8090 }, production: { isProduction: true, domain: myserver.com, port: process.env.PORT } }[process.env.NODE_ENV || 'development'];

Fix RepoLink component set state warning

This is a router component is mounted issue because of async call.
Suggest put to redux thunk async action.

Line 59
warning.js?8a56:44 Warning: setState(...): Can only update a mounted or mounting component. This usually means you called setState() on an unmounted component. This is a no-op. Please check the code for the RepoLink component

Admin tasks

  1. materialise admin template?
  2. Admin should save PNG as base64 if no avatar URL, then send to api as base64 - npm install base64-img --save
  3. admin build in api repo and save file uploads to uploads folder
  4. sanitise escape and trim and validate any post/put form data sent to API
  5. add images as a filename of the {slug}-{image order}.{img-prefix}

Deployment tasks

  1. Update all package.json files and README files
  2. git repos - branches and version tags
  3. dist/ files to server - source-maps should be ignored
  4. node compression
  5. CI : Codefolio to Github to travis to heroku, API to Github to travis to digital ocean
  6. Place copyright /licence on code files

Integrate Redux

Possibly need a rebuild with a redux boilerplate to start.

Add core frameworks to readme

Have icon, owner and brief explanation.
Eg React, Redux, React Router, Materialize, Webpack, Express.
Do this for API as well.

V1 pls

Same with the app please stamp and tag as v1.0.1 on this commit.
DV

auth tasks list

/register - if logged in show message saying you are logged in and only 1 admin can be registered and link to admin to edit administrator + show logout button

/forgot - if logged in show message saying you are logged in and will need to log out to reset password + show logout button

/reset - validate reset token and ensure API logout - i think api already does this so should be ok

** IF PUT ADMIN UPDATE PASSWORD RETURNS EXACT MESSAGE LOGIN EXPIRED ON SERVER THEN LOGOUT FRONTEND

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.