While this product is freely available on the web, you may also want to customize it or submit improvements. The guide below should help you get started.
- Node 7.0+
- NPM 5.0+
- Clone this repository:
git clone email@example.com:thegraidenetwork/rubric-creator.git
- Install npm dependencies:
- Run the development server:
http://localhost:4200/. The app will automatically reload if you change any of the source files.
If you want to test the service worker or offline functionality:
- Build the files for production:
ng build --prod.
- Install Node HTTP Server globally (should just need to do once):
npm install -g http-server.
- Navigate to the dist folder:
- And run the server:
http-server -c-1 ..
Your app should be running in production mode at
Running unit tests
npm test to execute the unit tests via Karma.
Running end-to-end tests
npm run e2e to execute the end-to-end tests via Protractor.
npm run lint to execute the linter via TSLint.
ng build to build the project. The build artifacts will be stored in the
dist/ directory. Use the
-prod flag for a production build and the
--aot flag for ahead-of-time compilation (recommended).
Contributions are welcome and encouraged to this open source project. Please be sure to submit an issue on Github to solicit discussion before jumping in as someone else might be working on the same thing.
Also be sure to read and adhere to our code of conduct.
Once you have built the files, you can copy them into a file hosting service like Azure's Blob Storage or Amazon S3. The following tutorials should help you get started:
This project was built on the back of many great open source projects. Here are a few of them:
Copyright 2020, The Graide Network
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
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.