CS Central

Contribute to CS Central

CS Central is a website that makes life easy for students, especially CSE students by making some daily-life web apps available in one place.

Yes!!, you're here!✨. This is the first step in making your contribution to the CSCentral-Hacktoberfest project.
This documentation will serve as a guide for making your contributions to this project. Follow the steps stated below carefully.

Finally, we can't wait to see your outstanding issues and pull requests. Welcome 😇❤

    CS Central is a website that provides combined characteristics of:

• Online Compiler
• Polyglot Projects
• Programming Competition Finder
• Currency Converter
• Post Office Locator
• News Web App
• Weather Forecast
• Translator
• QR Code Generator
• Dictionary
• Note Taking Web App
• Encryption-Decryption

Here! we welcome everyone to contribute to our project. You can contribute in several ways not just in code (E.g. Technical writing, collaboration in developing the website). Team working with a lot of folks is very good for the growth 📈 of the project but most of the time can lead to conflicting interests and points of view 👈👉. So, Below are set of rules 📖 that guide you for participating in this project.

• Openness 👐. Collaboration is only possible if everyone is open to sharing ideas.
• Respect 👨🏾‍🤝‍👨🏽. Having respect for everyone, their skills and opinions is paramount.
• Welcoming tone or politeness 😇: It is expected that you interact with others in an optimistic and cheerful manner.

Things to take care of while making a PR:

• Don't forget to attach a screenshot of the final output of the work that you have done, and do mention the issue you have worked on while making a PR.
• Just make sure that you push only the files that you have worked on.

• Demo

Check out the website.

Tech stack

Testing Tech stack

Installation and setup

Prerequisites

• GIT installed → https://git-scm.com/downloads
• Node.js installed → https://nodejs.org/en/download
• (optional, for testing reasons) VS Code IDE installed → https://code.visualstudio.com/
• (optional, for testing reasons) VS Code recommended Playwright plugin installed → Playwright Test for VSCode

Repository setup

1. to start contributing - install dependencies (such as tools for static code analysis):

   npm install
   

Test solution setup

1. to start contributing to tests - install Playwright with Chromium browser:

   npx playwright install chromium
   

Running Tests

• to run all tests: npx playwright test
• to run a specific test: npx playwright test {testfilename.ts}

Your First Contribution

Is this your first time contributing to an open-source project? If yes, Welcome!!✨🎉💃🏾 Here is a great tutorial on how to contribute to an open source project.

At this point, you are ready to take on the world of open-source contribution!!.

Steps to follow while making a contribution:

1. Create an Issue, and wait for it to be accepted.
2. After the issue is accepted and hacktoberfest-accepted label is added to it, you can start working on your local repository.
3. Push your local changes to remote and create a Pull Request. That's all! Your changes will then be reviewed by the maintainer.

For step by step explanation of how to push your local changes to remote, see our CONTRIBUTING.md file.

Code review process

The maintainer of CSCentral-Hacktoberfest looks at Pull Requests on a regular basis and carries out merging or comments on the requests. You can close a pull request if it isn't showing any activity after two weeks.

Contributing Guidelines

Any contributions you make are truly appreciated, go to our CONTRIBUTING.md file for more information.

Code of Conduct

View CODE_OF_CONDUCT.md

Thanks to all Contributors

License

If you liked this project, please leave a 🌟