dzCode.io

The code for dzcode.io, a website for Algerian open-source community.

Meta

env \ Project	Frontend (browser)	Data (static backend)
Production	https://dzcode.io	https://data.dzcode.io
Staging	https://staging.dzcode.io	https://data.staging.dzcode.io

Table of Content

• dzCode.io
  • Meta
  • Table of Content
  • Get Started
    • Perquisites
    • Run it locally
  • Contributing
    • Add Your Own Article
    • Fix Typos, or Edit existing Article
  • License

Get Started

Perquisites

Make sure you have:

• Git
• Nodejs version 10 or higher
• Yarn version 1 or higher

Run it locally

• Open terminal and clone the repo:

 git clone https://github.com/dzcode-io/dzcode.io.git

• Make sure you are in the project root:

 cd dzcode.io

• Install dependencies:

yarn

• Run it locally

yarn start

or with the api server (optional)

yarn start:api

• Now, Go to http://localhost:8080

• For api server, all emulators view status and logs at http://localhost:4000

Contributing

To get started see the contributing guidelines.

Unit test : Unit test are written in Jest. Please add a unit test for every new feature or bug fix. yarn test to run the test suite.

Add Your Own Article

Articles on dzCode.io are found under the folder data/articles.

To add new article let's say "Awesome New Article", simply do the following:

• Create a new folder Awesome_New_Article under data/articles
• Add two files:
  • info.json , a json file containing info about your article, like title, description etc..., see this file as an example.
  • content.md , a markdown file which contain your Article text, in form of markdown.
• Lastly, to make your article visible, modify the content of data/articles/list.json and add your article's folder name Awesome_New_Article inside the "items": [] array.

To test and see your article locally, make sure to you are all set, after you run dzCode locally go to http://localhost:8080/Articles/Awesome_New_Article, you will see your article, and you can continue editing from there, once you are happy with the result, create a pull request against master branch, and we will be happy to merge it 😃.

Fix Typos, or Edit existing Article

If you find a typo in any Article, or you find something that needs to be edited, please let us know, by applying the necessary modification, then create a pull request against master branch, and we will review it along with the article's author, then merge it.

License

Copyright (c) 2020 dzCode.io (twitter: @dzcode_io) Licensed under the MIT license.