TheDude
/
openproject
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
OpenProject is the leading open source project management software.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
22665 Commits
139 Branches
203 Tags
1.2 GiB
 
 
 
 
 
 
Tag: Branch: Tree: b2617ec688
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b2617ec688'
${ noResults }
openproject/frontend/doc
History
Florian Kraft b2617ec688
initial version for testing 		9 years ago
..
BUILD.md add a document with details on the build process 9 years ago
OVERVIEW.md minor overview of the folder structure for frontend 9 years ago
README.md add a document with details on the build process 9 years ago
TESTING.md initial version for testing 9 years ago

README.md

Developing OpenProject Frontend

Development server

To start the development server:

gulp dev

Living Style Guide

The style guide is available at: http://localhost:8080/assets/css/styleguide.html.

Changing or updating Dependencies

We use npm shrinkwrap to lock down runtime (but not development) dependencies. When adding or removing dependencies, please adhere to the following workflow:

npm install
npm shrinkwrap
./scripts/clean-shrinkwrap.js

Please commit npm-shrinkwrap.json along with any changes to package.json.

Topics

The individual topic for the documentation for the frontend are

  1. OVERVIEW.md - a general overview on the folder structure and a general "what is where"
  2. BUILD.md - notes on building the JavaScript for the asset pipeline
  3. TESTING.md - documentation of our approach to integration and unit testing
  4. STYLING.md - notes on styling and the Sass-Pipeline
  5. RAILS.md - an overview for the frontend parts still left in the Rails stack (mostly the JavaScript)