What is pushu.ps

Pushu.ps is a simple tracking app for your daily pushup workout. It's main purpose was to give me a look on how to build Svelte websites and learn the new thing. The app and the design itself are copyrighted but the source is open for learning purposes.

Created by Łukasz Krysiewicz

Development

To install the app locally you would need Node.js, npm and possibly git. Then you need to clone the repository:

git clone https://github.com/z-x/pushu.ps.git

Next, navigate to the local repository that you've just downloaded

cd x:/pushu.ps

And finally install the whole thing to get all the dependencies:

npm install

Run the development server

To run the dev server you just need to run

npm run dev

It should run the server at http://localhost:5000 by default so you can just type this into your browser navigation bar and you should see the app.

When runing the server this way you are also loading the developement version of the training. This means that it will be a short training with quick breaks between sets. This allows you to test faster.

You can also run the server with the production version of training with

npm run start

The code includes comments for easier understanding if you are looking for any particular solution. I am aware it could be better in places, but please keep in mind that this is just a side project done after hours.

Build the final package

To build the optimized and pure JavaScript package you need to run

npm run build

The output will be placed in public directory.

Production vs Developement

The app knows it should run in production mode when it finds the environment variable NODE_ENV set to production. It runs in developement mode otherwise.

The main difference is that in production mode it uses a real training data while on developement mode it just uses simplified version of training.

Testing

For end to end testing I am using Cypress. The tests are located in cypress/integration/test.js. To run the tests you just need to run

npm run test

Cypress client will open and will let you run tests. Keep in mind that the test.js file is written to test the developement version of the training. It is based on shorter breaks between sets and overall simplified version of the actual training. This is made so the test would finish faster. The prod.js tests just if the production data was loaded and nothing more.

This project uses GitHub Actions to automatically test each new pull request. The tests are runing on Vercel preview deployments.

Tech stack

• Svelte as a front-end framework
• Rollup.js as a module bundler
• Cypress for end to end testing
• Vercel for deployments
• GitHub Actions for CI/CD
• Photosop for the design

Where to find what

The master branch is where the current stable release sits. This is the branch that Pushu.ps main website runs.

License

The code and the design files are opened only for learning purposes, please keep in mind that the final app and it’s design are copyrighted.