https://github.com/jordanopensource/contributions-web
Web client for JOSA Contributions
https://github.com/jordanopensource/contributions-web
Last synced: 3 months ago
JSON representation
Web client for JOSA Contributions
- Host: GitHub
- URL: https://github.com/jordanopensource/contributions-web
- Owner: jordanopensource
- License: apache-2.0
- Created: 2021-05-03T10:51:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-11T09:05:50.000Z (9 months ago)
- Last Synced: 2024-08-12T09:57:14.435Z (9 months ago)
- Language: Vue
- Homepage: https://contributions.josa.ngo
- Size: 4.03 MB
- Stars: 9
- Watchers: 12
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
top-contributors-web
The web client for the Jordan Top Contributors website.
Explore the docs »
·
Report Bug
·
Request Feature
Table of Contents
## About The Project
This is a Nuxtjs web client for the Jordan Top Contributors Website, a website that displays the top contributors to open source repositories in Jordan.
### Built With
- [Nuxt.js](https://nuxtjs.org)
- [Tailwind CSS](https://tailwindcss.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/top-contributors-web.git
```
2. Install NPM packages
```sh
npm install
```
### Running
#### Development
To run the project locally for development purposes:
1. 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. Build the project
```sh
$ npm run build
```
2. Launch the production server
```sh
$ npm run start
```
## Roadmap
See the [open issues](https://github.com/jordanopensource/top-contributors-web/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/top-contributors-web](https://github.com/jordanopensource/top-contributors-web)