Skip to content

marksikaundi/Otofast-Project

Repository files navigation

build status service-test status coverage chat on Discord follow on Twitter

Welcome to the home of innovation at Otofast Project, Otofast Project is a vibrant community of technology enthusiasts and professionals who are passionate about exploring the latest trends and innovations in the tech industry. With a focus on fostering collaboration, creativity, and learning, the community provides a platform for members to connect with like-minded individuals, share their ideas and expertise, and participate in engaging discussions and events.

Whether you're a seasoned tech expert or just starting out in your career, Otofast offers a welcoming and supportive environment where you can learn from others, gain new insights and perspectives, and build meaningful connections with peers and mentors. Members of the community come from a diverse range of backgrounds and fields, including software development, data science, cybersecurity, AI, and more, making it a great place to explore different areas of interest and broaden your horizons.

From meetups and hackathons to online forums and social media groups, Otofast offers a range of opportunities for members to connect and engage with the community. Whether you're looking to network, collaborate on a project, or simply learn more about the latest trends and technologies, Otofast is the place to be for anyone passionate about tech.

Examples

  • code coverage percentage: coverage
  • stable release version: version
  • package manager release: gem
  • status of third-party dependencies: dependencies
  • static code analysis grade: codacy

Quickstart👨‍💻🪲

Browse a [complete list of featured you can contribute to][Ducumentation.md] and locate a particular badge by using the search bar or by browsing the categories. Click on the badge to fill in required data elements for that badge type (like your username or repo) and optionally customize (label, colors etc.). And it's ready for use!

Use the button at the bottom to copy your badge url or snippet, which can then be added to places like your GitHub readme files or other web pages.

Contributing Criteria

Otofast Project Community. We invite your participation through issues and pull requests. You can peruse the contributing guidelines.

When adding or changing a service please add tests.

This project has quite a backlog of suggestions! If you're new to the project, maybe you'd like to open a pull request to address one of them.

You can read a tutorial on how to add a badge.

GitHub issues by-label

Development

  1. Install Node 16 or later. You can use the package manager of your choice. Tests need to pass in Node 16 and 17.
  2. Clone this repository.
  3. Run npm i or yarn add to install the dependencies.
  4. Run npm run dev or yarn run dev to start the badge server and the frontend dev server.
  5. Open http://localhost:3000/ to view the frontend.

When server source files change, the badge server should automatically restart itself (using nodemon). When the frontend files change, the frontend dev server (gatsby dev) should also automatically reload. However the badge definitions are built only before the server first starts. To regenerate those, either run npm run defs or manually restart the server.

To debug a badge from the command line, run npm run badge -- /npm/v/nock. It also works with full URLs like npm run badge -- https://img.shields.io/npm/v/nock.

Use npm run debug:server to start server in debug mode. This recipe shows how to debug Node.js application in VS Code.

Daily tests, including a full run of the service tests and overall code coverage, are run via badges/daily-tests.

Related projects

Awesome

Since this is an open source project, feel free to suggest what basically looks good and great for the project then you can make a PR. Contributions may be considered there. (The presence of a project in that collection should not be interpreted as an endorsement nor promotion from the Shields project)

License

All assets and code are under the MIT LICENSE and in the public domain unless specified otherwise.

The assets in logo/ are trademarks of their respective companies and are under their terms and license.

Community

Thanks to the people and companies who donate money, services or time to keep the project running. Otofast Project