batta

A web-site for online auctions.

• Description:

  Many people enjoy making money by buying and selling things at auctions so they are obliged to go from one place to another which can cost money and time. Batta is web-site that allows people to participate in auctions online.

• Contributing:

  The main purpose of this repository is to continue evolving Batta, making it more efficient and easier to use. Development of Batta happens in the open on GitHub, and I'll be grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Batta.

  • Open Development: All work on Batta happens directly on GitHub. External contributors send pull requests which go through the same review process.

  • Branch Organization: Submit all changes directly to the main branch. I am not going to be using separate branches for development. Moreover, I am going to do my best to keep main in good shape, with all tests passing.

  • Bugs: I'll be using GitHub Issues for the public bugs. I'll be keeping a close eye on this and trying to make it clear when I have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist. The best way to get your bug fixed is to provide a reduced test case.

  • Proposing A Change: If you intend to make any non-trivial changes to the implementation, we recommend filing an issue. This lets me reach a decision on your proposal before you put significant effort into it. If you’re only fixing a bug, it’s fine to submit a pull request right away but I still recommend to file an issue detailing what you’re fixing. This is helpful in case I don’t accept that specific fix but want to keep track of the issue.

  • Sending Your First Pull Request: I'll be monitoring for pull requests. I will review your pull request and either merge it, request changes to it, or close it with an explanation.

    Before submitting a pull request, please make sure the following is done:

    1. Fork the repository and create your branch from main.
    2. Choose wether you want to contribute to the front-end or the back-end.
    3. Run npm install in the repository root.
    4. If you’ve fixed a bug or added code that should be tested, add tests!

  • Contribution Prerequisites:

    . You have Node installed on your machine. . You are familiar with Git. . You are familiar with React js. . You are familiar with REST API's. . You are familiar with Mongodb. . You are familiar with Express js.

  • License: By contributing to Batta, you agree that your contributions will be licensed under its MIT license.

• Original developers: Moetez Tounsi

• License: Batta is MIT licensed.