benhallouk / syntactic-library

Syntactic Library

Syntactic Library

Syntactic Library is an open source project that allow you to organise your code snippets and samples in one single location enabling you and your team to boost your productivity by providing very well organised code library that fits very nicely with your preffered IDE such as Visual Studio, Itellij, Eclips and the cutting edge editors like VS Code and Sublime

Getting started with this project

---

This project is written in Java spring boot, angular 2 with typescript and sass.

To get started you will need:

• 10 Minutes
• Java editor of your choice (STS is recommended)
• Latest node and npm version Node js

To start clone the syntactic library

git clone https://github.com/benhallouk/syntactic-library.git 

Navigate to the UI folder

cd syntactic-library\src\main\resources\UI

Install node and angular dependencies

First ensure you have the latest npm version by running the command

npm update npm -g

Then install all the client depandancies including development tools using the command bellow:

npm install

node_modules and typings directories should be created during the install.

To build the UI and transpile all typescript and sass run the command:

npm run build

public directory should be created during the build inside the target class path

To start the development run the application from the IDE of your choice

Then run the command to start the browsersync for pleasant development

npm run start

The application should be displayed in the browser and the gulp tool will watch the client side changes and relead and sync the browser automatically.

Want to help?

---

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing and then check out the issues we have in our backlog

License

---

Copyright (c) 2016 Amine Benhallouk

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.