Skip to content

Timer - A web application to log passed time by project.

Notifications You must be signed in to change notification settings

Almorisson/ipssi-timer-client

Repository files navigation

Project Timer Manager logo

Project Timer Manager - Client

Project Timer Manager is a web application to log passed time by project that allow users to manage its projects, teams and logged times.

This part concerns the Frontend side of the web application. The application you are going to interact with.

Manage your projects easily with Project Timer Manager(PTM) by creating an account then teams and projects and logging all your tasks to top it all off.

Prerequisites

Before you begin, ensure you have met the following requirements:

  • If you have a Windows, Linux or a Mac machine, that's fine, you're good to go.

Installing Project Timer Manager - Client side

Rename the .env.example file in the root folder and put the correct values in the respective variables.

Here are values to put in .env.example

REACT_APP_GRAPHQL_ENDPOINT=http://localhost:8080/graphql # important to keep it like so 
REACT_APP_REST_ENDPOINT=http://localhost:8080 # important to keep it like so 
REACT_APP_COMPLETE_REGISTRATION_ENDPOINT=http://localhost:3001/complete-registration # important to keep it like so 
REACT_APP_REDIRECT_LOGIN_ENDPOINT=http://localhost:3001/login # important to keep it like so 

Using Project Timer Manager

To use Project Timer Manager , follow these steps:

docker-compose up --build

Now the client is ready to communicate with the backend and you begin using it by going on `` can.

You can play with the API without the front if you wish by going on: http://localhost:8080/graphql.

Note: You must know how to make GraphQL queries and mutations.

Contributing to Project Timer Manager

To contribute to Project Timer Manager, follow these steps:

  1. Fork this repository.
  2. Create a branch: git checkout -b <branch_name>.
  3. Make your changes and commit them: git commit -m '<commit_message>'
  4. Push to the original branch: git push origin Project Timer Manager/<location>
  5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Here are the people who actively contributed to this project:

You might want to consider using something like the All Contributors specification and its emoji key if you want to contribute to the project.

Contact

If you want to contact me you can reach me at mo.ndiaye@ecole-ipssi.net.

License

This project uses the following license: The MIT License (MIT).