Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 1.25 KB

CONTRIBUTTING.md

File metadata and controls

56 lines (38 loc) · 1.25 KB

Setup and Development

How to setup

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

#Fork the repo.

# Clone this repository
$ git clone https://github.com/<your GitHub name>/Jia_SSG.git

# Install the package
npm install

# Run the app
$ node .\index.js [option] <file/folder> [option]

Example

From the main directory

$ node index.js -i file.txt -l fr - Generate file.txt with the fr language. $ node index.js --input /SherlocksStories - Generate files inside of the folder.

Scripts

Using prettier

#To run the prettier, use the following command:
npm run prettier

#To check if prettier have fix code formatting, use the following command:
npm run prettier-check

Using elint

#To fix any mistake, use the following command:
npm run lint

#To check if the files have any mistake, use the following command:
npm run lint-check

VS Code settings

Extenstions

  • Prettier v2.4.1
  • ESlint v8.1.0

Settings

  • Install prettier and Eslint for the correct settings
  • .vscode/ has the configuration settings for Prettier and Eslint.