Git Product home page Git Product logo

cs-537-csm's Introduction

๐Ÿ“ฑ CS-537-CSM

Cal State Mobile - mobile website for the Cal State university students.

๐Ÿ’ Developer Guidelines

  • master branch should always be stable and deployable
  • When you are working any feature, please branch out from latest commit on master branch, create a pull-request when you are done with implementation
    • Always do a git fetch && git pull origin master when you start branch from master
  • Before you start coding, write down the test cases for the feature, and implement test cases under test/java so that you can test your codes when you are done. This will help us to create more reliable code
  • When you open a pull request, be descriptive on what you have done. Assign a person to review your code before you merge your code to the master
  • Document your code! Keep your code maintable, you are not the only one to look at it.

โ“ How to run the project

๐ŸŒ” Use Eclipse

  1. Under Eclipse, go to file>import select Existing Maven Project
  2. Select the CS-537-CSM folder for the Root Directory, and click finish
  3. To run the project, right click on the project run as and select maven build
  4. In the dialog, type in tomcat:run in the goal
  5. Open any browser of your choice, type in the following in the address http://localhost:8080/csm/rest/hello/user

๐Ÿ‘ Use Terminal

  1. Download maven if you are using windows.
  2. Execute mvn tomcat:run at the root directory of this project (CS-537-CSM)
  3. Open browser and go to http://localhost:8080/csm to check if tomcat is running

๐Ÿ  Project Architecture

.
โ”œโ”€โ”€ pom.xml
โ”œโ”€โ”€ README.md
โ””โ”€โ”€ src								// where our source code goes
ย ย  โ”œโ”€โ”€ main
ย ย  โ”‚ย ย  โ”œโ”€โ”€ java							// Java source codes
ย ย  โ”‚ย ย  โ”œโ”€โ”€ resources
ย ย  โ”‚ย ย  โ””โ”€โ”€ webapp						// front end stuff
ย ย  โ”‚ย ย      โ”œโ”€โ”€ bower_components					// bower componetns / front end libraries
ย ย  โ”‚ย ย      โ”œโ”€โ”€ css						// css files
ย ย  โ”‚ย ย      โ”œโ”€โ”€ img						// images
ย ย  โ”‚ย ย      โ”œโ”€โ”€ index.html					// home page
ย ย  โ”‚ย ย      โ”œโ”€โ”€ js						// angularjs logic
ย ย  โ”‚ย ย      โ”œโ”€โ”€ lib						// extra libraries
ย ย  โ”‚ย ย      โ”œโ”€โ”€ partials						// partial pages
ย ย  โ”‚ย ย      โ”œโ”€โ”€ test						// karma test
ย ย  โ”‚ย ย      โ””โ”€โ”€ WEB-INF
ย ย  โ”œโ”€โ”€ scripts							// sql scripts
ย ย  โ”‚ย ย  โ”œโ”€โ”€ create-csm.sql
ย ย  โ”‚ย ย  โ””โ”€โ”€ drop-csm.sql
ย ย  โ””โ”€โ”€ test							// JUnit Test
ย ย      โ”œโ”€โ”€ java
ย ย      โ”‚ย ย  โ””โ”€โ”€ org
ย ย      โ””โ”€โ”€ resources

cs-537-csm's People

Contributors

elnazbayazian avatar gayanehp avatar rcliao avatar samansaeedi avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

elnazbayazian

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.