Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.53 KB

SETUP.md

File metadata and controls

62 lines (51 loc) · 2.53 KB
Raw

Project startup

Dependencies

  1. Install Node.js LTS. At the time of writing the documentation this is version 12.18.0
  2. Install Yarn
  3. Install Git
  4. Do following instructions

What you need to work on your blog

First you need to download the project code from the repository, then we recommend you install VSCode. It has everything you need: a code editor, a terminal and a GUI for working with git. We recommend enabling auto-save on file changes. In the following sections we will describe how to start a project using VSCode as an example.

How to start a project

Open the project folder in VSCode. To start the project open a terminal and execute there the following commands ``cmd yarn

This command will install all the dependencies the project needs.

> Possible problem: Dependencies installation crashes with an error
> ```
> error An unexpected error occurred: "https://npm.pkg.github.com/download/@csssr/[...]: Request failed
> "401 Unauthorized"
> ```
> Solution: Make sure you've done step 4 of [dependencies](#dependencies) correctly

After that you can start the project:
``cmd
yarn dev

Possible problem: The project crashes with an error

{
code: 'EACCES',
errno: -4092,
syscall: 'listen',
address: '0.0.0.0',
port: 3000
}

Solution 1: If port 3000 is busy with another project you don't need right now, stop it and run `yarn dev' again

Solution 2: if there's no way to free port 3000, start the blog on a different port with the command yarn dev -p 8080, where you specify the desired port instead of 8080

The yarn command only needs to be executed once, the yarn dev command needs to be executed every time you start the blog.

Local host is the address of the server you run on your computer, By default it's http://localhost:3000/. Only you will have access to this address.

After you see message about successful build of the project you can go to the local host address and you will see the blog site.

After saving the article file, just refresh the page in your browser and you will see the changes.

Well, you have started the project, but what's next?

Read about work with git