The webapp for Venue, a community engagement platform for the Volentix community
This repository houses the artifacts for the UI of the Venue platform. The main technologies used for this software are:
Before running the Venue client, make sure you have the following installed on your machine.
- Venue Server.
- Yarn or NPM (we recommend yarn)
- Node
Open a terminal in the root of this project and then change into the 'venue' directory:
cd venue
Install dependancies.
yarn install
When running locally, the application is available here: http://localhost:3000
Once the project is installed, the following commands are used to run/build the project.
In order for the client to communicate without the need for CORS, you must first run the nginx reverse proxy. Note that the files to create the nginx proxy can be found in this repository here.
The result of running this proxy is that all the traffic will be sent through localhost. As a result, you can reach the venue server with http://localhost/api or the client with http://localhost.
To run the nginx proxy on linux:
docker run -p 80:80 --net="host" volentixlabs/venue-local-proxy:v0.1.0
To run the nginx proxy on Mac:
docker run -p 80:80 volentixlabs/venue-local-proxy-mac:v0.1.0
If you don't want to run this proxy for some reason, you can manually modify nuxt.config.js to point directly
to the server:
axios: {
baseURL: 'http://localhost:3000'
// baseURL: process.env.BASE_URL || 'http://localhost/api',
// browserBaseURL: process.env.BROWSER_BASED_URL || 'http://localhost/api'
},
Serve with hot reload at http://localhost
npm run dev
Start the server:
npm start
Build for production and launch server
yarn run build
Venue is a project which was originally created by Volentix Labs, but is owned and maintained by the Volentix community. We actively support and appreciate anyone who wants to improve this or any project within the community.
See CONTRIBUTING.md
Small note: If editing the README, please conform to the standard-readme specification.
MIT © 2018 Volentix Labs Inc