Logo Lanfrica

umabubakar16/BuildForSDG

Record type:

project
Creator:
uma
Host:
BuildForSDG is a challenge project from Google and Andela for Africa developers to come up with solutions that can provide positive impact for their community barebones setup for JavaScript / Node projects replace this with a one-liner phrase describing this project or app ## About What is this project about. Ok to enrich here or the section above it with an image. Once this repo has been setup on Codacy by the TTL, replace the above badge with the actual one from the Codacy dashboard, and add the code coverage badge as well. This is mandatory This is a simple JavaScript starter repo template for setting up your project. The setup contains - Jest: For runnung tests. We strongly recommend that JavaScript projects use Jest - Eslint & Prettier: For formatting code to match ESlint AirBnB coding standard. You might need to install the ESlint and Prettier plugins for your code editor to make the most of these utilities ## Why Talk about what problem this solves, what SDG(s) and SGD targets it addresses and why these are imoirtant ## Usage How would someone use what you have built, include URLs to the deployed app, service e.t.c when you have it setup ## Setup Install `npm` or `yarn` if you dont have any of them already installed. We recommend Yarn though. After clonning the repo to your local machine and moving into the cloned folder, Run `yarn install` to get started by installing dependencies. `src/index.js` is the entry to the project and source code should go into the `src` folder. All tests should be written in the `__tests__' folder. There's a sample in there. This starter uses Parcel as the bundler. It is much simpler that WebPack and the others #### Hints - Run `npm install` or `yarn install` to get started. We'll assume you are using Yarn. - Install additional dependencies: `yarn add [-D]` - Run tests: `yarn test` - Run tests with test coverage info: `yarn test:cover` - Check the codebase for proper syntax and formatting compliance: `yarn lint` - Run your app in local dev mode: `yarn start`. This puts the bundled app in a `dist` folder, set up a local web server at localhost:1234, and continues t …

Licenses