Git Product home page Git Product logo

glorious-triven's Introduction

Glorious Codes

Glorious Codes website

CircleCI Coverage Status

Contributing

  1. Install Node. Download the "Recommend for Most Users" version.

  2. Clone the repo:

git clone [email protected]:glorious-codes/glorious-codes.git
  1. Go to the project directory
cd glorious-codes
  1. Install the project dependencies
npm install
  1. If you want to just build the project, run:
npm run build
  1. Otherwise, run:
npm run start

The app runs on http://localhost:7000. The browser automatically reloads for any source file changes.

Tests

  1. Ensure that all code that you have added is covered with unit tests:
npm run test
  1. You can optionally generate coverage report after running tests:
npm run test -- --coverage

glorious-triven's People

Contributors

dependabot[bot] avatar rafaelcamargo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

glorious-triven's Issues

Make a general diagram

Make a general diagram to explain how Triven works under the hood. Consider the following expectations to draw that diagram.

Expectations

  • It will be used by developers familiar with Node/NPM. ✓
  • One markdown file should be enough to generate a blog ready to be published.
  • No markdown files should be enough to generate a blog ready to be published. ✓
  • Distributable files should go to a directory called triven by default. ✓
  • Markdown files should optionally accommodate metadata like: ✓
    • title, date, description, keywords, externalUrl, excerpt, language.
  • A homepage showing 10 posts per page should be created automatically. ✓
  • Should contain a base style theme as basic as possible. ✓
  • Should copy relative images used on posts to local assets directory. ✓
  • Clients should be able to create markdown files containing just metadata (pointing to external articles) ✓
  • Clients should be able to customize the name and path of the output directory. ✓
  • Clients should be able to define a HTML template to be used as article. ✓
  • Clients should be able to define a HTML template to be used as homepage. ✓
  • Should copy relative assets used on templates to local assets directory. ✓

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.