UntitledNodeProject

Welcome to UntitledNodeProject! This is a community-based project where each user will only be allowed to contribute a maximum of 500 lines of code (with a maximum of 100 lines of code in deletions).

Requirements & Instructions

To get started, you'll need the latest LTS version of Node.JS (12.x.x) which can be downloaded here, which also installs NPM.

Clone the repository locally, navigate to the repisitory in your command line, and type npm i. To run the code, type npm start. We recommend using Visual Studio Code to edit the code and make commits.

The Rules

Each user can only make one successful Merge Request. You need to send a link to your Merge Request on the v3rm thread, and all Merge Request that are not linked will be declined - no matter how good they are!
Your Merge Request will be declined if you add any more than 500 lines of code, or if you remove any more than 100 lines of code.
Your Merge Request will be declined if you add any code outside the ./src folder. No changing package.json or anything like that.
Your code cannot connect to the internet. After npm i is run, the application will not make any web calls. The only use of a connection will be for the app to install the following modules that we've added:
- Koa (this is similar to express).
- ffi-napi (yes, you can add C code),
- win32-api - why not? idk what people are gonna try to make.
- Electron - its electron
- is-even - checks if a number is even
- is-odd - checks if a number is odd
- (I will consider adding more as needed and by request.)
The app must build with the eslint rules given, and you may not write one-liners.
Nothing you add to this can break v3rmillion rules.

How to Merge Request

To work on this project, you will need to "Fork" the project, make your changes, and then perform a merge request to add your code.

eslint

We're using eslint rules to automatically fail builds which don't match the eslint config found in .eslintrc. This means your PR will fail if your code is not properly beautified. To check if your code will meet the style rules, run this in the terminal.

npm run lint

If you install the eslint extension for VSCode, you can see style errors while you're typing. To do this, install the extension and then run the following in your terminal:

npm i eslint -g

Don't use one-liners.

Unfortunately, I can't find any eslint rules to prevent people from writing one liners. It's still possible to do this:

const a = () => { const b = 'b'; return b }

Because we're not allowing you to commit more than 500 lines of code, we can't just have you minifying all your code into one line. So, we're checking for this manually when approving your merge request.

xetrics/UntitledNodeProject