https://github.com/jordanopensource/nuha-web
Web client for NUHA
https://github.com/jordanopensource/nuha-web
Last synced: 3 months ago
JSON representation
Web client for NUHA
- Host: GitHub
- URL: https://github.com/jordanopensource/nuha-web
- Owner: jordanopensource
- License: apache-2.0
- Created: 2023-05-18T12:22:54.000Z (about 2 years ago)
- Default Branch: development
- Last Pushed: 2024-11-27T09:32:12.000Z (6 months ago)
- Last Synced: 2024-11-27T10:30:28.069Z (6 months ago)
- Language: Vue
- Homepage: https://nuha.josa.ngo
- Size: 5.3 MB
- Stars: 3
- Watchers: 9
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
### nuha-web
The community hub for JOSA.
[Explore the docs »](https://github.com/jordanopensource/nuha-web)
[Visit the Portal]()
.
[Report Bug](https://github.com/jordanopensource/nuha-web/issues)
.
[Request Feature](https://github.com/jordanopensource/nuha-web/issues)
[](https://builds.josa.ngo/jordanopensource/nuha-web)
Table of Contents
## About The Project
This is a Nuxtjs web client for the [Nuha Project](https://nuha.josa.ngo).
### Built With 🤖
* [Nuxt.js](https://v3.nuxtjs.org/)
* [Tailwind CSS](https://tailwindcss.com/)
We recommend to look at the [documentation](https://v3.nuxtjs.org).
___
## 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/nuha-web.git
```
2. Install NPM packages
```sh
npm install
```
### Running
#### Development
To run the project locally for development purposes:
1. Run the project
```sh
yarn run dev
```
2. Go to `http://localhost:3000`
#### Production
To build and run the project locally for production purposes:
1. Build the project
```sh
yarn run build
```
2. Launch the production server
```sh
yarn run start
```
Checkout the [deployment documentation](https://v3.nuxtjs.org/docs/deployment).
___
## Roadmap
See the [open issues](https://github.com/jordanopensource/portal-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 be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)
3. Commit your Changes (`git commit -m 'Add some amazing-feature'`)
4. Push to the Branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
___
## License
Distributed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
___
## Contact
Jordan Open Source Association - [@jo_osa](https://twitter.com/@jo_osa)
Project Link: [https://github.com/jordanopensource/nuha-web](https://github.com/jordanopensource/nuha-web)