Skip to content

Latest commit

 

History

History
153 lines (104 loc) · 3.5 KB

README.md

File metadata and controls

153 lines (104 loc) · 3.5 KB
Raw
Logo

nuha-web

The community hub for JOSA.

Explore the docs »

Visit the Portal . Report Bug . Request Feature

Build Status

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

This is a Nuxtjs web client for the Nuha Project.

Built With 🤖

We recommend to look at the documentation.

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/nuha-web.git

  2. Install NPM packages

    npm install

Running

Development

To run the project locally for development purposes:

  1. Run the project
yarn run dev
  1. Go to http://localhost:3000

Production

To build and run the project locally for production purposes:

  1. Build the project
yarn run build
  1. Launch the production server
yarn run start

Checkout the deployment documentation.

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 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 for more information.

Contact

Jordan Open Source Association - @jo_osa

Project Link: https://github.com/jordanopensource/nuha-web