portal-web
The web client for the JOSA Portal.
Explore the docs »
Visit the Portal
·
Report Bug
·
Request Feature
Table of Contents
About The Project
This is a Nuxtjs web client for the JOSA Portal.
Built With
Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
- Download and install the latest version of Node.js from here.
Installation
- Clone the repo
git clone https://github.com/jordanopensource/portal-web.git
- Install NPM packages
npm install
Running
Development
To run the project locally for development purposes:
- Run the project
$ npm run dev- Go to
http://localhost:3000
Production
To build and run the project locally for production purposes:
- Build the project
$ npm run build- Launch the production server
$ npm run startRoadmap
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE for more information.
Contact
Jordan Open Source Association - @jo_osa - [email protected]
Project Link: https://github.com/jordanopensource/portal-web