Giter Club home page Giter Club logo

better-first-issues's Introduction

Better First Issues

Allows Developers to better look for, and select their first open source contribution. You can also use this tool to just look for random repositories or issues that might fancy you.

Visit the tool here.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

Requirements for the software and other tools to build, test and push.

  • Node - I use Node v16.6.2 but really anything 12+ should work.

Installing

Clone this repository to your machine and run

npm install

To start up the dev server, run this:

npm run dev

Running the tests

We have no tests :(

Sample Tests

We'd like to add test cases. Check out the issues to learn more.

Style test

Check if the best practices and the right coding style has been used. Run an npm run lint to see if there's any styling errors. Also run npm run lint:fix to fix issues that can be auto-fixed.

Note that the build process will fail if there are lint issues.

Deployment

NextJS works a bit differently to other JS dev-build cycles. To prepare for deployment, run this command:

npm run build

This compiles and bundles the code into the .next folder. After this is done, run this command to start the production server.

npm run start

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the CC0 2.1 Universal Creative Commons License - see the LICENSE file for details

Acknowledgments

  • Daren Sin - Created Good First Issues, the inspriation for this project - darensin01
  • Billie Thompson - Provided README Template - PurpleBooth
  • Tom Boettger - Provided CONTRIBUTING Template - bttger

better-first-issues's People

Contributors

arvind0598 avatar dependabot[bot] avatar emmadawsondev avatar guscarpim avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.