Almorisson / ipssi-timer-api

A project management app that allow both teams and users to see time passed on a given project

Project Timer Manager - API

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 Backend of the web application. In other words, the API.

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

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

PORT=8080
# To use on localhost
MONGO_LOCAL_URI=mongodb://localhost:27017/ipssi_timer
# To use when you use MongoDB Atlas cloud Database services
# To use on localhost with Docker

# Cloudinary env vars
CLOUDINARY_CLOUD_NAME=almorisson
CLOUDINARY_API_KEY=279468386239394
CLOUDINARY_API_SECRET=zKAmTy6RYYOqk28qnrc5StBLSyM

Using Project Timer Manager

To use Project Timer Manager , follow these steps:

To install Project Timer Manager, follow these steps:

docker-compose up --build

Now the API is ready to communicate with the front.

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:

• @almorisson 📖

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 [e-mail].

License

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