Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/rafalschmidt97/skelvy-api

Api for mobile app for meetings over your favourite activities 🚀
https://github.com/rafalschmidt97/skelvy-api

Last synced: 2 days ago
JSON representation

Api for mobile app for meetings over your favourite activities 🚀

Host: GitHub
URL: https://github.com/rafalschmidt97/skelvy-api
Owner: rafalschmidt97
Created: 2018-12-29T14:42:58.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-08T11:32:04.000Z (almost 2 years ago)
Last Synced: 2023-03-04T08:37:50.393Z (over 1 year ago)
Language: C#
Homepage: https://skelvy.com
Size: 4.99 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        This repository is a part of **skelvy** project. It includes api for mobile app.

Created with dotnet core and aspnet. Crafted with love to new technologies! 

[![Build Status](https://travis-ci.com/rafalschmidt97/skelvy-api.svg?token=z2Ugw1HzqG3BK6LFW2LT&branch=master)](https://travis-ci.com/rafalschmidt97/skelvy-api)

There are other parts of the system which are located within different repositories:

- [Mobile apps (Android and iOS) - Ionic 4 and Angular 8](https://github.com/rafalschmidt97/skelvy-client)

- [Website - Wordpress](https://github.com/rafalschmidt97/skelvy-website)

- [Utilities - additional tools, graphics](https://github.com/rafalschmidt97/skelvy-utilities)

## Idea

The idea for Skelvy is extremely simple as it a tool for arranging and finding meetings over favourite activities in the city. Users log in to the app, fill in the meeting parameters with when, where and what they are planning or simply would like to do. Meetings always might be open to the public so other people in the area would see them in their explore tab.

![Mockup](docs/mockup.png)

## Tech stack

C#, REST with ASP.NET Core 3.0 (the structure heavily inspired by jasontaylordev/NorthwindTraders - with CQS approach, FluentValidation and EF configs in external files), MSSQL (docker), Entity Framework, Dapper, Redis (docker) for cache and services backplane, Scheduling tasks with Coravel, OpenAPI with Swagger, Email Templates with Razor, Geolocation with Google Maps, Authorization with Facebook and Google (JWT), Websocket with SignalR for real time communication (chat + in app notifications), Firebase Messaging for Push Notifications, TDD, Xunit, Moq, Sqlite for testing, Logging with Serilog, Linting with StyleCop and FxCop, Azure Storage for uploading photos, CI with TravisCI, deploy as docker image to Azure App Service (with Azure MSSQL and Redis).

The app is translated into 9 languages:

- Polish

- English

- German

- Spanish

- French

- Italian

- Russian

- Finnish

## Database schema

![Schema](docs/schema.png)

## Video introduction

[![Video](docs/youtube.png)](https://youtu.be/_uS4fBgzgC4)

- [English Youtube Video](https://youtu.be/_uS4fBgzgC4)

- [Polish Youtube Video](https://youtu.be/kRucIyZtuGA)

## Deployment setup

- Buy AppStore license and configure the app within App Store Connect:

  - Fill basic app information (category, tags, keywords, description, version release setup)

  - Check pricing (Free?) and availability (it used to be configured for 38 of 175 countries and regions)

  - Setup testers and TestFlight, app revision information

  - Configure different localizations (currently English, Finnish, French, German, Italian, Polish, Russian and Spanish are supported)

![App Store Connect](docs/appstore-connect.png)

- Similarly pay registration fee for Google Play and configure in similar manner:

![Google Play](docs/google-play.png)

![Google Play Dashboard](docs/google-play-setup.png)

- Create firebase app to configure push notifications. For Android you need to generate and fill SHA-1 certificate fingerprints.

![Firebase](docs/firebase.png)

- Prepare all necessary resources on azure:

  - App Service + App Service Plan

  - MSSQL Database

  - Redis (for caching google maps requests)

  - Blob Storage (+ add container) - for profile images

  - (Optional) DDOS Protection Plan + Virtual Network

 

![Azure](docs/azure.png)

- Create API Key for Google Maps (same dashboard as config for Google Plus)

- Configure authentication

Facebook Auth:

![Facebook](docs/facebook.png) 

Google Plus Auth

![Google](docs/google-auth-maps.png) 

\+ Apple Auth (required from the newest version) - not implemented yet.

## Contributing guidelines

We really hope that good instructions for contributing will make the history of our app more readable. 

Take a look [here](CONTRIBUTING.md).

## Development

Current state of development is available to see on [trello](https://trello.com/b/MCzNyRJf).

## Stay in touch

* Website - [skelvy.com](https://skelvy.com/)

* Facebook - [skelvyapp](https://facebook.com/skelvyapp/)

* Twitter - [skelvyapp](https://twitter.com/skelvyapp/)

* Instagram - [skelvyapp](https://instagram.com/skelvyapp/)

* Email - [[email protected]](mailto:[email protected])