[DEPRECATED] See the https://github.com/TextUp/textup.github.io for the consolidated TextUp site now served on GitHub Pages.
You will need the following things properly installed on your computer.
- Clone the repository. Since this repository uses
git subtree
to share core styles with other repositories, this repository and its subtree can be cloned in one of the two following ways.
git clone --recursive <repository-url>
git fetch
+git submodule sync --recursive
+git submodule update --init --recursive
- Change into the new directory
- For ease of use, create a remote to the core styles repository with
git remote add styles [email protected]:TextUp/textup-styles.git
npm install
Separate changes to the subtree application from changes to the core styles. When pushing or pulling from this repository, use the standard methods. When working with changes that pertain to the core styles, you must first use the following commands to update your copy of the core styles
git subtree pull --prefix=styles/core --squash styles master
When you need to backport any changes to the core styles repository, the simplest way to do so is by using this command
git subtree push --prefix=styles/core --squash styles master
However, the main drawback of this command is that all commits that touched the subtree and used. If we need more control, we can cherry pick the commits we want to push to the subtree.
More details about this and about all git-subtree related commands can be found at this tutorial
- Change directories to the root of this project
- If Python 2,
python -m SimpleHTTPServer
- To initially build stylesheet,
node-sass -o . styles/main.scss
- To watch stylesheets for subsequent changes,
node-sass -o . -r -w styles/main.scss
- Visit your app at http://localhost:8000.
Copyright 2017 TextUp
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.