This repository exists to support Guest Authors. To become a guest author, please, apply through the Guest Author Program webpage. The process is simple and fully described in the referenced page.
After implementing the sample application and defining an outline to your article, please, follow the instructions in this section to start writing your article:
- Fork this repository.
- Clone your fork to your machine.
- Create a branch with a name that references your article (e.g.,
react-firebase). - Run
node srcand answer the questions asked. - Find your article in the
./articlesdirectory (e.g.articles/2018-04-10-title.markdown). - Start writing.
- Commit and push your branch to your fork.
- Create a pull request to the original repository.
- Share with your editor.
Note: You can commit, create the pull request, and share it with your editor even before you finish writing. Like that, the editor might be able to take a quick look and give you feedback before you proceed with the rest of the article.
One of the most important resources that you must read before start writing is this one. Please, make sure you understand everything written there and do ask questions if you have doubts.
Before executing the commands shown below, please, be sure that Docker and Node.js are properly installed and that both docker and node commands are available.
- Check that Docker is available:
docker --version; - Check that Node.js is available:
node --version; - To create a new article, issue the following command:
node src; - To see how your article will look in our blog, issue the following command:
node src/docker;
The blog engine might take a few seconds to start and generate the articles (usually less than 10 seconds). After started, we can check the blog at http://localhost:4000/blog/ (note that the trailing slash is mandatory).
Important!!! The trailing slash is mandatory. This means that
http://localhost:4000/blogwon't work. You do have to go tohttp://localhost:4000/blog/.