Project developed using the github API to display basic information about your repositories.
Before you begin, make sure you have met the following requirements:
- You need the latest version of
Elixir/Phoenixon your machine.
If you need installation instructions, click here.
To install Repository Summary, follow these steps:
1º Clone the repository.
> git clone https://github.com/joabehenrique/repository-summary.git
2º Open the project in your vscode and run the command
> mix deps.get
3º Just run project
> mix phx.server
To use Repository Summary, follow these steps:
Development project using the Github API, where through
a request is returned some basic information of the
repositories of your account.
The project is also a challenge from the elixir
trail on rocketseat.
Getting a repository summary
(GET) api/v1/github/user/{username}
Create a user
(POST) api/v1/github/user/signup
{
"password": "aduy324!@"
}
Log in with your user
*to get the token and access the route from repository summary
(POST) api/v1/github/user/signin
{
"id": 2,
"password": "aduy324!@"
}
To contribute to Repository Summary, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <nome_branch>. - Make your changes and commit them:
git commit -m '<commit_message>' - Send to the original branch:
git push origin Repository Summary / <local> - Create the pull request.
Alternatively, see the GitHub documentation at how to create a pull request..
We thank the following people who contributed to this project:
|
Joabe Henrique [Author] |
Do you want to be part of this project? Click here and read how to contribute.
This project is under license. See the license file for more details.