Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

Latest commit

 

History

History
65 lines (41 loc) · 3.37 KB

README.md

File metadata and controls

65 lines (41 loc) · 3.37 KB
Raw

License: MIT GitHub package.json version (branch) Libraries.io dependency status for GitHub repo GitHub contributors GitHub commit activity

Coding Garden Community App Frontend

This repository contains the source files of the Coding Garden Community App Frontend. For more information about Community App please visit the App Wiki.

Opening/Serving the Frontend locally:

REMEMBER: If you find yourself in some trouble going through this, reach out to us directly on our Discord server.

Prerequisites

  1. NodeJS:
    Please install NodeJS >= 10.15.0. Which automatically installs NPM. If you already have them, you're good to go. ✔

  2. EditorConfig:
    Please visit EditorConfig -> Download a Plugin section and scroll through to see if you need to install an additional Plugin/Extension for your code editor or IDE. If your IDE needs one, you should be able to find a link to that plugin/extension on that page.

    This prerequisite is directly related to the .editorconfig file in the root directory of this project.

    More About EditorConfig:
    EditorConfig helps maintain consistent coding styles for multiple developers working on the same project across various editors and IDEs. The EditorConfig project consists of a file format for defining coding styles and a collection of text editor plugins that enable editors to read the file format and adhere to defined styles. EditorConfig files are easily readable and they work nicely with version control systems.

Once you have the Prerequisites covered:

  1. Clone this repository from GitHub onto your local computer.

    $ git clone https://github.com/CodingGardenCommunity/app-frontend.git

  2. Navigate into the project folder and install all of its necessary dependencies with npm.

    $ cd app-frontend
$ npm install

  3. To make sure everything is setup properly, run tests.

    $ npm run ci

    If all tests pass, we can safely conclude that setup is complete and its working as expected. 🙌 Wooh!!
    If not, don't worry. We are together on this!! Reach out to us directly on our Discord server.

  4. Once that's done, tap your back even if it feels awkward. You are ready to start contributing 😃
    You can run -

    $ npm run serve

    to start the local development server.

You can now visit http://localhost:8080/ to view the frontend of the application.

Further, checkout package.json file to learn about (more) available scripts/commands.

Happy coding! 🥂