Giter Club home page Giter Club logo

meeopp's Introduction

MeeOpp App

File Structure

meeopp/
  |--client/                                  //-- All the client side work (React,Redux)
  |  |--public/                               //-- The public folder contains the HTML file
  |  |--mocks/                                //-- All the jest setup
  |  |--tests/                                //-- All the test cases files
  |  |--src/                                  //-- Wrapper for app components
  |     |--assets/                            //-- Controller related to users
  |     |--redux/                             //-- All redux work of app
  |     |--routes/                            //-- Routing of app using BrowserRouter
  |     |--services/                          //-- Server side processing
  |     |--views/                             //-- Application logic (all the components)
  |     |--App.css                            //-- Css work
  |     |--index.js                           //-- Initialization of app
  |
  |--server/                                  //-- All the server side work
  |  |--common/                               //-- All the common functions(utility functions)
  |  |--controllers/                          //-- All the application controllers
  |  |--database/                             //-- Database configuration for MeeOpp App
  |  |--models/                               //-- All the application models
  |  |--routes/                               //-- All the application routes
  |  |--server.js/                            //-- Main server JS file (Entry point)

Install application dependencies

For server side

$ cd Project_Folder/
$ npm install

For client side

$ cd Project_Folder/
$ cd client
$ npm install

Build

Run the Client side (React app).

$ cd Project_Folder/
$ cd client
$ npm start

Run the App server.

$ cd Project_Folder/
$ cd server
$ nodemon server.js

Development Pipeline

For each feature/task, create a new branch as follows:

  1. Sync from development branch.
  2. Create a new branch from development with the pattern: year/userName/feature

For example: 2018/Kapil/implementedRedux

  1. Make changes (Please commit frequently whenever a change has been made. do not commit everything at once!)
  2. Commit frequently to year/userName/feature.
  3. When a new task is completed or a significant milestone is reached, create a Pull Request (PR) to development.
  4. Reviewers will review your Pull Request and accept or reject with feedback.
  5. If rejected, review and fix and create another Pull Request.
  6. If accepted, your changes will be merged into the development branch.

Linting

Linting keeps our code to a certain standard. We are following the standard Airbnb ES6 styling.

Understand what linting is and how to install it here.

Linting in mandatory and must be integrated as part of your work flow. All pull requests will be rejected if they are not linted.

Assistance and questions

If you have any questions or need any assistance with anything, please sent us an email- [email protected].

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.