Giter VIP home page Giter VIP logo

howru-spring-2024's Introduction

HOWRU-Spring-2024

This repo is for CIS 4951 - Capstone II, Project: HOWRU.life app. Group work will be placed here. Good luck!

Stress and Anxiety Management - HOWRU.Life Documentation

This is the README for the web application ONLY please refer to the Android app to view that applications README.

File Structure

StackEdit stores your files in your browser, which means all your files are automatically saved locally and are accessible offline!

howru
├── public
	|	├── audio
	|	|	├── ...
	|	├── ...
├── server
	|	├── src/
	|	|	├── utilities/
	|	|	├── firebase.js
	|	|	├── main.js
	|	├── .env
├── src
│   ├── Assets/
	| 	├── ...
	├── Components/
	|	├── componentName/		
    	├── componentNameStyling/
		|	|	├── componentNameStyling.css
		|	├── componentName.js
	├── Styling/
	|	├── ...

File Structure Organization Rules

The Stress and Anxiety Management web app is quite large. Therefore a structure must be kept in order to maintain readability and to easily find everything. The public folder is to be able to easily access a document from anywhere in the application. Things like audio/images and other files that would be posted on the web app.

  • server folder
    • The server folder is meant for anything that will be communicating with the database/APIs ect. The information for the database is stored in a .env file that your team would create and reference throughout the folder. This was not added to the project due to security.
    • All API endpoints are created in the main.js
  • src folder
    • Assets/ is for the images/audio *Components When creating pages in the components folder here are some things to keep in mind:
    • Each page has its own folder within the components/
    • Specific components for a page should be in a folder within the page's folder.
    • Components that are in many pages i.e. navigation menu should be within the GeneralComponents folder.
  • Styling folder
    • Used for any global commonly used styling throughout the whole web app.

How to Start web app

  • Prerequisites: Node JS, React JS, Express JS
    • First start client app by opening up the terminal in howru/ and type the following:
      • npm install
      • npm start
    • Opening up a separate terminal in howru/server/ and leaving the client app terminal open in the background type the following:
      • npm install
      • npm run dev

License

This project is licensed under the BSD-Clause 3.

howru-spring-2024's People

Contributors

irodr1502020 avatar rafaelojeda 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.