abc-ability-ui v0.1.4

abc_ui

This folder includes the frontend for ABC project using Next.js.

Getting Started

Prerequisites

You will need Node and npm for this project. If you do not have them installed on your machine, you may follow the instructions here for installation.

Installing

Run the following to install the dependencies of the project.

npm i

Run locally

Start the server by running command below. Visit http://localhost:3000/ when it is up.

npm run dev

Directory Structure

.
|-- components
|   |-- Component
|   |   |-- index.js            # component definition
|   |   |-- Component.scss      # component style file
|   |-- ...
|-- pages
|   |-- index.js                # index UI
|   |-- index.scss              # index style file
|-- static
|   |-- placeholder.js          # static image files
|   |-- ...
|-- script
|   |-- build.sh
|   |-- post_process.py
|-- .npmignore
|-- next.config.js              # Next.js config
|-- package.json
|-- package-lock.json
|-- postcss.config.js
|-- server.js
|-- README.md

Build static HTML file

1. Update version in package.json

2. Run following to generate the updated HTML file. For details of what has been done, please look into the script file.

./build.sh