Journeys

This is a Angular based Geo Spatial Single Page Application(SPA). The Application is deployed using gh-pages.

Since application uses geographical information, data is being processed in GeoJSON format. Open Street Map is being used for displaying geospatial data with help of Map based JavaScript Library Leaflet.

Helpful Links

• Journeys Application
• REST API Documentation
• REST Open API YML Configuration

Getting Started

Please find below steps to set up and run application in your workstation.

Prerequisites

The service uses MongoDB for persistence. For Local development, Local MongoDB instance created with help of Docker CLI. So make sure you have installed Docker CLI or any other docker container tool.

Installation

1. Download Repository

   git clone https://github.com/nramc/journeys.git 

2. Set up your environment.development.ts to have
   1. Development Journey-API BFF service
   2. Your Cloudinary's cloud name and preset
   3. Optional Cloudinary base directory for development
3. Run Application

   npm run start

Contribution

Any contributions you make are greatly appreciated.

If you like the project and have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'feat: Add the AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Release new version

1. Manually run Release Workflow
2. The Workflow flow uses Conventional Changelog Action Plugin, which determines next version based on commit logs
3. Based on the determined release type (MAJOR or MINOR or PATCH), bump version in package.json
4. The Workflow creates Release as well with release notes and make the release as latest
5. As soon as new Release created, which triggers gh-page deploy workflow
6. When build successful, Application available on https://nramc.github.io/journeys

Contact

Ramachandran Nellaiyappan Website | Twitter | E-Mail

Credits

Sincere Thanks to following open source community for their wonderful efforts to make our life much easier.

• Open Street Map - Open Source Map Provider
• Leaflet - Map based JavaScript Library
• GitHub Pages - Hosting static resources
• Angular - TypeScript based Single Page Application(SPA) Web Framework
• Bootstrap - Open Source CSS Framework
• Angular Material - Open Source UI Component library for Angular
• Angular Gallery - Open Source Media Gallery library for Angular

Show your support

Give a ⭐️ if you like this project!