An open API service indexing awesome lists of open source software.

https://github.com/cstodor/angular-lightning-slider

Simple and Lightweight Image Slider made with Angular 5
https://github.com/cstodor/angular-lightning-slider

Last synced: 10 months ago
JSON representation

Simple and Lightweight Image Slider made with Angular 5

Awesome Lists containing this project

README

          

# Angular Lightning Slider
[![Build Status](https://travis-ci.org/cstodor/Angular-Lightning-Slider.svg?branch=master)](https://travis-ci.org/cstodor/Angular-Lightning-Slider)
[![Dependency Status](https://david-dm.org/cstodor/Angular-Lightning-Slider/status.svg)](https://david-dm.org/cstodor/Angular-Lightning-Slider)
[![devDependency Status](https://david-dm.org/cstodor/Angular-Lightning-Slider/dev-status.svg)](https://david-dm.org/cstodor/Angular-Lightning-Slider)
[![GitHub version](https://badge.fury.io/gh/cstodor%2FAngular-Lightning-Slider.svg)](https://badge.fury.io/gh/cstodor%2FAngular-Lightning-Slider)
[![Join the chat at https://gitter.im/Angular-Lightning-Slider/Lobby](https://badges.gitter.im/Angular-Lightning-Slider/Lobby.svg)](https://gitter.im/Angular-Lightning-Slider/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Known Vulnerabilities](https://snyk.io/test/github/cstodor/angular-lightning-slider/badge.svg?targetFile=package.json)](https://snyk.io/test/github/cstodor/angular-lightning-slider?targetFile=package.json)

# Prerequisite
1. NodeJS (>=8.9.4 or greater) https://nodejs.org/en/
2. Angular CLI (>=1.6.7 or greater) https://cli.angular.io/
3. TypeScript (>= 2.4.2) https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html

# QUICK START
1. Download source code
2. Open terminal in the folder where you've downloaded the app
3. Run `npm run install-client-and-server` from your terminal. This will install the dependencies for Client/Server
4. Build the App for both Client and Server, by running `npm run build-client-and-server`from your terminal
5. Run the App with `node public/server`
6. Open your browser, and navigate to: `localhost:3000` Enjoy!

## Image Sources
Images are loaded from https://unsplash.com/ using the Unsplash API (https://unsplash.com/developers)

You can change the API endpoint from the `constants.ts`, located at `server/constants.ts`. Make sure that you re-build the server after adding your API credentials by running `tsc -p ./tsconfig.server.json` from your terminal.

# Developement

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `public/dist/` directory. Use the `-prod` flag for a production build.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).

# License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.