Git Product home page Git Product logo

tfi-cassy-frontend's Introduction

CASSY Data Management Platform

Functionality

A data managment web platform designed to allow its target users enter data about their operations and to generate reports from the data entered into the system

Running the Application

To run and test it locally, run following command after you clone the repo:

### Step I: Install dependencies
bower install & npm install

### Step II: Start up application server
npm start

Application Dependencies

Front-End dependencies are in bower.json and package.json files Back-End dependencies are in package.json file

Run bower install and npm install to install

Technology Stack

Database Configuration

This application uses MySQL server hosted on Amazon AWS.

  • Database Name: cassydev
  • Schema: therapists, students, staff, events, districts

Development: Extending the Application Front-End

Local server runs on port 8888. To extend the front-end subsystem of the CASSY application, you need to create following modules:

Actions:

  • Create action: /actions/{ENTITY_NAME}Action.js. For example, /actions/studentActions.js`
  • Include the action module you created in the /actions/actions.js index file in the root directory of the project

Data Sources

  • Create data source: /apis/{NAME}.js
  • Data sources include modules that make API calls to the server and local storage modules

Reducers:

  • Create reducer: /reducers/{ENTITY_NAME}Reducer.js. For example, /reducers/schoolReducers.js`
  • Include the reducer module you created in the /reducers/reducer.js index file in the root directory of the project
  • Add the reducer module created to the list of registered reducers in the store configuration file /store/configureStore.js

View

  • Create component: /public/components/ either as a js or jsx file /public/components/{NAME}.js
  • Create page: /public/pages/ either as a js or jsx file /public/pages/{NAME}.js
  • Make sure to import the page and add it to the specific route in /public/client.js using the right naming convention. For example, import {NAME}Page from "./pages/{NAME}.js"
  • (Optional) Include components as aliases in ./webpack.config.js

For the back-end subsystem, you need to create the following modules:

Model

  • Create model: /models/{NAME}.js. For example, /models/user.js`
  • Create model tester(optional): /test/{NAME}Model.js

Router

  • Create router: /routes/{NAME}.js
  • Register your router in app.js
  • Create router tester(optional): /test/{NAME}.js

Services

  • Create services: /services/{NAME}.js
  • Server side APIs called from the client side

Deployment:

This application is currently hosted on Heroku [https://www.heroku.com] (https://www.heroku.com) and can be accessed via the URL https://cassydataportal.herokuapp.com

To deploy on Heroku, use command git push heroku master

tfi-cassy-frontend's People

Contributors

uduakeren avatar

Watchers

James Cloos avatar  avatar Anup Kher avatar Uduak 'Eren avatar

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.