Giter Club home page Giter Club logo

website's Introduction

Ouracademy

Ouracademy is an organization that promoves the education in software development throught blog posts & videos ๐Ÿ˜ƒ.

This website is created using Gatsby, MDX & Grommet for UI. It uses many Gatsby plugins for offline, analytics (through Google Tag Manager), Syntax Highlight (through Prismjs) and GraphQL for fetching Github (to automatically generate versioning of posts).

It also has a new-post script to help you create new posts using inquirer.js.

npm run new-post command in action


How write a post

  • Clone this repository

  • Install & Run it following this steps

  • Create .env file (similar to .env.sample file) and put your Github token there - this is used to fetch Github and versioning posts, get your token here.

  • If you are a new author (put your information) in authors.yaml file.

  • Run npm run new-post to create a new post

  • Start writing, please follow this guideline to commit your post

Guide for commit messages

We use commit lint in order to have a standard for commit messages. So if you create or update the content of a blog post, please use the docs type in your commit message, for example a commit message like docs: new "post title" is ok.

Also we use the docs type in our commit messages, to show a change history of every post (see <History/> component in posts/template.js).


Development

npm install
npm run develop

Your site will run at http://localhost:8000!

Note: You'll also see a second link: http://localhost:8000/___graphql. This is a tool you can use to experiment with querying your data.

Some notes..๐Ÿง

We highly recommend that you install the recommended extensions if you use VS Code. It will make your development sweet ๐Ÿฐ

Resources

This project use Gatsby. See more of it in its awesometutorial, it has very useful resources not only to learn Gatsby but also GraphQL, React & plugins for any purpose...

If you don't know MDX, well it's just markdown & with JSX. So you could import components if you needed.


License

MIT License

website's People

Contributors

artmadeit avatar clara081094 avatar qpdian avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

website's Issues

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.