https://github.com/felipeclarindo/tech-mech-api
Api for the Tech Mech project developed in java.
https://github.com/felipeclarindo/tech-mech-api
api api-development api-rest java java-maven oracle oracle-database
Last synced: 24 days ago
JSON representation
Api for the Tech Mech project developed in java.
- Host: GitHub
- URL: https://github.com/felipeclarindo/tech-mech-api
- Owner: felipeclarindo
- License: agpl-3.0
- Created: 2024-11-07T11:12:18.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-24T03:57:01.000Z (3 months ago)
- Last Synced: 2025-02-07T14:41:39.128Z (3 months ago)
- Topics: api, api-development, api-rest, java, java-maven, oracle, oracle-database
- Language: Java
- Homepage:
- Size: 29.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🌍 [Leia em Português](README.pt-BR.md)
# Tech Mech Api
This is an API developed in java in order to perform manipulations in the database for the Tech Mech project.
## Technologies used
- `Git` - Version control.
- `Java`- Development of api.
- `Maven` - Build automation and dependency management tool for the api.
## Requirements for installation
Make sure you have the `node`, `npm` and `Java Development Kit` installed in your machine for run the project.
## Steps for installation and run the API
1. Clone the repository:
```bash
git clone https://github.com/felipeclarindo/tech-mech-api.git
```
2. Enter the directory of api:
```bash
tech-mech-api
```
3. Configure your oracle database credentials in `src/main/java/resources/application.properties`.
4. Execute sql locate at `sql/table/clients.sql` in the database.
5. Run the file `Main.java`.
## Steps for installation and run the Front-end
1. Clone the front end repository:
```bash
git clone https://github.com/felipeclarindo/tech-mech.git
```
2. Enter the directory:
```bash
cd tech-mech
```
3. Now let's run the front-end (Make sure the api is running)
```bash
npm install
```
4. Run the project locally (make sure the java API is running as well):
```bash
npm run dev
```
5. Click on the link provided in the terminal, usually:
- `http://localhost:3000`
## Contribution
Contributions are welcome! If you have suggestions for improvements, feel free to open an issue or submit a pull request.
## Authors
- [Felipe Clarindo](https://github.com/felipeclarindo)
- [Victor Augusto](https://github.com/victoraugustogfavaro)
- [Jennie Suzuki](https://github.com/jenniesuzuki)
## License
This project is licensed under the [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).