Skip to content

lingin1230/pycontw-frontend

 
 

Repository files navigation

pycontw-frontend ci pycontw-frontend cd nuxt

pycontw-frontend

Frontend of PyCon TW official website.

Set up a Development Environment

Requirements

  • node >= 12.20.2

You can refer to package.json file for more details.

Method 1: Develop on your local machine

  1. Clone this repository.

  2. Add Environment Variables to configure this project:

    export BUILD_TARGET=server                   
    export HOST=127.0.0.1
    export BASE_URL=http:https://127.0.0.1:9876
    export API_URL_BROWSER=http:https://127.0.0.1:9876
  3. Install dependencies:

    npm install
  4. Serve with hot reload at localhost:3000:

npm run dev
  • Also, we have mock server to handle API on local:
# You need to add Environment Variables(Step.2). Otherwise, some of the pages may not work correctly.
npm run json-server

Method 2: Run Development Server with Docker

  1. Clone this repository.
  2. Simply run the docker-compose commands to launch or stop the mock API server & the dev server:
# Launch the dev server and the mock API server
docker-compose -f ./docker-compose-dev.yml up

# Stop the dev server and the mock API server
docker-compose -f ./docker-compose-dev.yml down

Start to contribute

  • You can choose method 1 or method 2 to build setup, then you can start to contribute. 🙌
  • Please follow Github Flow.

Build for production and launch server

npm run build
npm run start

# Or just run:
npm run serve

Generate static project

npm run generate

Check your code:

npm run lint

For detailed explanation on how things work, check out Nuxt.js docs.

About

The official website for PyCon TW 🐍

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Vue 59.8%
  • JavaScript 40.0%
  • Other 0.2%