Colonyal -

Front and Backend files for Colonyal WebApp. (colonyal)

Table of contents

Colonyal
Tech Stack
Running colonyal
Observations
Developers Team
Contributors

Colonyal

It’s very common for expats in a new country to seek other expats around them to share feelings, help each other and create friendships. This is however very difficult when there is no centralized place to create that connection.

Colonyal has arrived to make expats feel at home while transforming their experience in the new country by being part of a big family. As a Colonyal you can connect with similar minded individuals and be informed about the latest events, news, jobs but also where you can buy your favorite products from back home. Colonyal allows any individual to sell these products - while automatically receiving payment in their bank account.

Providers can also offer services and host events or experiences so that others can get to know the culture of the new country through the eyes of a co-patriot; The App is a P2P Community Marketplace connecting providers that wish to sell products and services with expats. It implements Stripe Connect to handle the distribution of payment while collecting a small fee for the platform.

It allows a community of expats to be created through events, news, blogposts and also help individuals to find jobs, places to stay and much more. Experience a new world with Colonyal!

Once you're logged in you can browse through different products, make a purchase, browser events, and news articles - You will discover many type of local products offered by different providers, with the ability to pay for postage for delivery.

It's very easy to register as a provider, and you can start creating new products in no-time. As a provider you decide the price, delivery method, etc. Buyers will soon be booking your product and you can start obtaining additional revenue in an automated manner.

Tech Stack

Backend

Frontend

CI / CD

• Github Features
• Trello

Hosting

• Netlify for Frontend and Backend

Authentication

• Session Cookies with bcrypt

APIs

• Stripe Connect

Running colonyal

• Fork & clone this repo

• Run npm i in colonyal directory

• Adjust the necessary env variables to match your system. There's a .env.copy file to help you with this process. (You will need an API key for Stripe)

• Run npm start

• Make sure you have postgreSQL installed on your machine mac || windows

• Run npm i in colonyal/server directory

• Adjust the necessary env variables to match your system. There's a .env.copy file to help you with this process.

• Edit the ./config/config.json file with your database details.

• With the database running, run npm run recreateDb. This will generate the tables in the database and seed the data to get the project started.

• Run nodemon in colonyal/server directory

Observations

Upcoming Pull Requests

• Deploy colonyal to the web
• Create PWA

Engineering, Design and PM

😋 German - Github - LinkedIn

Contributors ✨

German 🚇 💻

This project follows the all-contributors specification. Contributions of any kind welcome!