https://github.com/atlasoflivingaustralia/commonui-bs3-2019
ALA header, footer, theme and javascript files required for 2019 website refresh
https://github.com/atlasoflivingaustralia/commonui-bs3-2019
ala-systems
Last synced: 3 months ago
JSON representation
ALA header, footer, theme and javascript files required for 2019 website refresh
- Host: GitHub
- URL: https://github.com/atlasoflivingaustralia/commonui-bs3-2019
- Owner: AtlasOfLivingAustralia
- License: mpl-2.0
- Created: 2019-04-03T00:51:52.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T03:07:33.000Z (8 months ago)
- Last Synced: 2025-01-19T12:13:26.572Z (4 months ago)
- Topics: ala-systems
- Language: HTML
- Size: 5.92 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# commonui-bs3-2019
ALA header, footer, theme and javascript files required for 2019 website refresh
## Setting up development environment
### Repository cloning
This repository contains a couple of git submodules. Therefore, there is a bit more work than just cloning repo from
github. Run the following commands.
`git clone --recurse-submodules https://github.com/AtlasOfLivingAustralia/commonui-bs3-2019.git`
`cd commonui-bs3-2019`
`git submodule foreach --recursive 'git checkout commonui-bs3-2019'`
_Above command will checkout the correct branch of submodule._
### Working with submodule
Make sure changes submodules are made on `commonui-bs3-2019` branch. Then publish those changes to github
using `git push`. In order for others to checkout your change, run the following command on the root repository - `commonui-bs3-2019`.
`git add bootstrap-sass`
`git add ala-wordpress-2019`
### Installing dependencies
Install dependencies using yarn.
`brew install yarn`
`cd PROJECT-PATH`
`yarn install`
### Create buildvars file
Copy the buildvars-example.js file to a new file named buildvars.js (which is git-ignored).
Edit the variables as needed to define things like the login/logout URLs etc for different dev/build/prod environments.
You can also store copies of different buildvars files in a directory named 'buildvars-ignored'
### Building project
Build project to generate CSS from SCSS, compress and concatenate files. The tool used to build project is Gulp.
`./node_modules/.bin/gulp build`
### Serve built files
You might want to test the integration of built files with applications like ala-hub, specieslist etc locally.
The built in server will do it. The address is `http://localhost:8099`.
`node server.js`
Example usage - `http://localhost:8099/css/jquery-ui.css`
### Test page
The project has a test page to visualise changes. Use the following link.
`http://localhost:8099/testPage.html`
### Adding a dependency
Add a npm library using `yarn`. Yarn is used to preserve the version of the dependency across installations of this repo.
`yarn add xxx`
### Auto build
It is possible to build project after editing a file automatically. Use the following command.
`./node_modules/.bin/gulp watch`