Skip to content

The web application that will help you keep track of exactly how much you smoke and how much you spend on it

Notifications You must be signed in to change notification settings

jedahee/JointCounter

Repository files navigation

JointCounter

The web application that will help you keep track of exactly how much you smoke and how much you spend on it.

    Get Started Log in Currency data Home Stats

Getting Started 🚀

You only need to clone the project in a local environment. To execute you must run the command 'ng serve'.

See Deployment for how to deploy the project.

Prerequisites 📋

You must have any supported browser (Chrome, Firefox, Safari, etc).

You must have installed:

- Angular CLI: Run this command for install Angular CLI npm install -g @angular/cli

- Node (NPM Package) Ver

Installing 🔧

These are the next steps to be able to execute the project in your local environment:

You can use Git or Github to clone the project in a local environment. If you use Github you must click on the button that says 'Code' and then on 'Download Zip'. But if you use Git you can use the following command:

git clone https://github.com/jedahee/JointCounter.git)

We enter inside the root directory with:

cd /your/path/JointCounter

Now we need to install the project dependencies by executing the command:

npm install

You should now have your copy of the project in your local environment ready to run. Run the following command in root project directory:

ng serve

Navigate to http:https://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding ☕

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Testing 🧪

Running unit tests

Run ng test to execute the unit tests via Karma.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

Deployment 📦

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

This project is deployed in Vercel.

If you want to try the project visit:

https://joint-counter.vercel.app/

Built With 🛠️

Some of the tools that I used to create this project:

  • HTML - Web skeleton
  • SCSS - Used for web design
  • TS/JS - Used for web logic
  • Angular - Web Frontend Framework
  • Async code
  • Interfaces - Object Data types
  • Modules - Structure the web parts
  • Services - Fetch requests

Project structure 🏗️

the structure of the project is as follows:

app/ - interceptors/: Intercepts all requests and inserts the validation token in the headers
- services/: Files where fetch requests
- pages/: Page components, integrate components of the shared/ folder
- models/: Interface for allowed response types
- shared/: Shared components between any modules
route-animations.ts: For Page Transitions
assets/ - fonts/: fonts used in the web app
- i18n/: JSON with key/values for traductions
- icons/: Icons directory, usually, SVG images
- img/: Images directory, usually, PNG/JPG images
styles/ - base/: Basic/Reset styles
- components/: Styles for small components in web app
- layout/: Responsive design pages
- typo/: Typography styles and fonts
- views/: Page styles
- utilities/: Variables of scss

styles.scss: File where all the scss files are joined

Contributing 🖇️

This project is not open for new contributions

Versioning 📌

Version: 1.0.0

This is the only version.

I used Git and GitHub for the versioning of this project

Authors ✒️

The different works I have done for this project:

  • Me - Initial Work and development - jedahee
  • Me - Documentation - jedahee

License 📄

This project does not have any lincence.

Acknowledgments 🎁

  • Tell others about this project 📢
  • Invite a beer 🍺 or a coffee ☕ to someone on the team.
  • Say thank you publicly 🤓.

About

The web application that will help you keep track of exactly how much you smoke and how much you spend on it

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published