Skip to content

Home

Jump to bottom
akbel edited this page Apr 22, 2020 · 10 revisions

Welcome to the language-platform wiki! This wiki is the main source of documentation for contributors and who wants to work with the liguaSphere project.

Navigation

  1. About LinguaSphere
  2. Contribute
  3. Installation
  4. How to Use
  5. Technologies

LinguaSphere

This repository is created for the final project of Hack Your Future Belgium using technologies such as MongoDB, Express, NodeJS, and ReactJS. It is our first attempt to build a full-stack web application. We aimed to create, explore and run a web app in a development environment, then deploying it to the production environment by applying the Test-Driven-Development approach.

LinguaSphere shows you available volunteer jobs or internships according to your language, location, and field preferences. In this short time, we could add a few features to app like login - logout, create a profile page and edit it, email recognition when you signed up, etc. We will add more features as we learn more.

Contribute

We have 6 contributors in this repository. Our rules are simple:

  1. Open an issue to work on or assign yourself on an issue that already exists.
  2. Use labels on the issues to point what is that issue about and the urgency of the issue etc.
  3. Work on branches, not in master.
  4. When pulling requests, at least one of the contributors has to review the changes, and all the conflicts must be solved so that you can merge your branch to master.

If you like to contribute to add new features, reporting a bug, share new ideas; please let us know via email string@domain.com

Installation

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

  • Clone this repository

  • Go into the repository

    • $ cd language-platform

  • Install dependencies for backend

    • $ npm install

  • Go into the client folder and Install dependencies for frontend

    • $ cd client
    • $ npm install

  • Create a file named config on the root folder

    • $ cd language-partner
    • $ touch jest.config.js

  • Create a file named .env on the root folder

    • $ touch .env

  • Run the app

    • $ npm start

To see the basic file structure with all the necessary files and code in it for Continues Deployment you can visit this Repo from colevandersWands.

How to Use

  • After the installation, open a new branch:

    • $ git checkout -b

  • Work on that branch to add new features or fix an issue. Commit and push your changes

    • $ git add .
    • $ git commit -m "added a new feature to .."
    • $ git push origin

  • Send a pull request: Once your work on a branch is complete and is ready to be merged into the master branch, create a pull request on GitHub.

Technologies

  • React
  • React-redux
  • axios
  • Node.js
  • loopback 3
  • mongodb(mlab , robo3T)
  • Heroku
  • bootstrap 4
  • matrial-ui
  • ES6

Clone this wiki locally