contributions-api

The Api client for the Jordan Top Contributors website.
Explore the docs »

· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

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

• Express
• MongoDB

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.

Installation

1. Clone the repo

   git clone https://github.com/jordanopensource/contributions-api.git

2. Install NPM packages

   npm install

Running

Development

To run the project locally for development purposes:

1. Copy the env file and change the values inside

$ cp .env.sample config.env

2. Run the project

$ 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

$ npm run start

Roadmap

See the open 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 - [email protected]

Project Link: https://github.com/jordanopensource/contributions-api