https://github.com/jordanopensource/contributions-cron
Cron job for the JOSA Contributions
https://github.com/jordanopensource/contributions-cron
Last synced: about 1 month ago
JSON representation
Cron job for the JOSA Contributions
- Host: GitHub
- URL: https://github.com/jordanopensource/contributions-cron
- Owner: jordanopensource
- License: mit
- Created: 2021-11-07T13:17:26.000Z (over 3 years ago)
- Default Branch: development
- Last Pushed: 2025-03-20T09:37:03.000Z (2 months ago)
- Last Synced: 2025-04-12T17:12:12.079Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 183 KB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
contributions-cron
This is the cron job for the Jordan Top Contributors website.
Explore the docs »
·
Report Bug
·
Request Feature
[](https://builds.josa.ngo/jordanopensource/contributions-api)
Table of Contents
## About The Project
This is a Express api client for the Jordan Top Contributors Website, a website that displays the top contributors to open source repositories in Jordan.
### Built With
- [NodeJs](https://nodejs.org/en)
- [MongoDB](https://www.mongodb.com/)
## Getting Started
To get a local copy up and running follow these simple steps.
### Prerequisites
1. Download and install the latest version of Node.js from [here](https://nodejs.org/en/download/).
### Installation
1. Clone the repo
```sh
git clone https://github.com/jordanopensource/contributions-cron.git
```
2. Install NPM packages
```sh
npm install
```
### Running
#### Development
To run the project locally for development purposes:
1. Copy the env file and change the values inside
```sh
$ cp .env.sample .env
```
2. Run the project
```sh
$ npm run dev
```
2. Go to `http://localhost:3000`
#### Production
To build and run the project locally for production purposes:
1. Launch the production server
```sh
$ npm run start
```
## Roadmap
See the [open issues](https://github.com/jordanopensource/contributions-cron/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Apache License. See `LICENSE` for more information.
## Contact
Jordan Open Source Association - [@jo_osa](https://twitter.com/@jo_osa) - [email protected]
Project Link: [https://github.com/jordanopensource/contributions-cron](https://github.com/jordanopensource/contributions-cron)