Workout Mate is there for you when you need to keep track of your physical activity. It lets you submit exercise whenever you want and without any real-life relevance if that's what you prefer. Workout Mate doesn't judge. Workout Mate lets you be the athlete you want to be.

1. App Features and Limitations
2. Local Usage
3. Tools and Dependencies
4. Environment variables
5. Todos
6. Author

As a user, you can create an account on Workout Mate from the Signup page with a valid email address and a strong password. You will then be sent an email with a link to confirm your account. Clicking on the link, you will be redirected to the page that will inform you that your account has been confirmed successfully and you can go to the Login page and use your credentials to access your account. If you enter wrong credentials, you will be alerted so.

Every workout card contains a "delete workout" (trash can) and "edit workout" (pen) icons at the bottom right of the card. By clicking on the trash can, the workout will be deleted from the database. By clicking on the pen, the Edit workout form will pop up and it will be pre-filled with the current workout details. After editing the workout and clicking save, the workout will be updated with the new details. You can opt out of editing by clicking "X".

If you happen to forget your password, you will be able to recover it by first clicking on "Forgot the password?" found in the login form, which will open a "Reset password request" form that will ask you to enter your email address that you have an account with. Once you correctly enter your email address and click "Proceed", you will be alerted to check your inbox for an email with the password reset link. When you click on the password reset link, you will be redirected to the password reset page that will contain a single form asking you to type your new password in two input fields. The form will check the strength of the new password as well as whether the passwords are matching before you will be allowed to finish the password reset. Once you've successfully reset your password, you will be able to access your account with it.

All users and posts are subject to automated deletion, oldest first, when the limits set on their quantity in the database are exceeded. If too many requests are sent to the server within a set timeframe, the server will respond with an error and reject further requests for a while.

1. Clone the repo;
2. Create and populate .env file;
3. Run this script on your postgres database:

 CREATE TABLE wm_users (
    _id INT8 PRIMARY KEY, 
    created_at TIMESTAMPTZ DEFAULT (now()), 
    email TEXT, 
    password TEXT, 
    username TEXT, 
    profile_image TEXT,
    account_status TEXT DEFAULT ('pending')
);
CREATE TABLE account_confirmation (
    id INT8 PRIMARY KEY, 
    user_id INT8,
    token TEXT,
    expires TIMESTAMPTZ DEFAULT (now() + '1 day'::interval)
);
CREATE TABLE password_reset (
    id INT8 PRIMARY KEY, 
    user_id INT8,
    token TEXT,
    expires TIMESTAMPTZ DEFAULT (now() + '1 day'::interval)
);

4. While in root directory, copy-paste and run:

cd backend && npm install && npm run dev && cd ../frontend && npm install && npm start

npm run test to run backend and frontend tests in corresponding directories.

• NodeJS - Server logic
• Express - Routing
• Cookie-parser
• MongoDB - Database
• Supabase - Database
• Node-Postgres - PostgreSQL client for Node.js
• Mongoose - MongoDB document modelling
• Bcrypt - hashing passwords
• Dotenv - secret-keeping
• Cors - enabling CORS requests
• JWT - Authentication
• Validator - request (input) validation
• Nodemailer - Email sending middleware
• Handlebars - Email templates
• Ethereal email - Mock SMTP service
• Express rate limit - Request rate limiting

• Jest - Javascript testing framework
• Supertest - testing HTTP requests
• MongoDB Memory Server - testing/mocking MongoDB memory server in NodeJS
• @shelf/jest-mongodb - A Jest preset for running MongoDB memory server
• Sqlite3 - In-memory test database

• React - User interface
• React router - Browser routing
• Redux - State management
• React easy crop - Image cropping
• Date-fns - Date formatting
• ChartJS - Charting library
• React ChartJS - ChartJS library for React
• SASS - Styling

If you want to run the app in your local environment, you'll need to create a .env file in each of the second-level directories and provide values for the variables below.

#--- Mandatory variables ---#

PG_USER=
PG_PASSWORD=
PG_HOST=
PG_DB=
MONGO_URI=
SECRET=
SALT=
#--- Get fake email account here: https://ethereal.email/create
EMAIL_HOST=
EMAIL_USERNAME=
EMAIL_PASSWORD=

#--- Below are optional ones, defaults are provided ---#

PORT=
CLIENT_URL=
ORIGIN=
AUTH_TOKEN_EXPIRES_IN_MS= # in milliseconds

#--- Database limits:
MAX_USERS=
MAX_WORKOUTS_PER_USER=

#--- Rate limiter:
MAX_API_WORKOUTS_REQS=
MAX_API_USERS_REQS=
MAX_API_RESET_PASSWORD_REQS=

#--- Rate limiter windows (in milliseconds):
API_WORKOUTS_WINDOW_MS=
API_USERS_WINDOW_MS=
API_RESET_PASSWORD_WINDOW_MS=

#--- Defaults provided ---# REACT_APP_API=
REACT_APP_WEB_SERVICE=localhost

• Users should have an option to commit to using their account and posting workouts to avoid automated deletion.

@marija-kov