https://github.com/tylher/fullstack-test
This is a take-home assignment for a job
https://github.com/tylher/fullstack-test
Last synced: 2 months ago
JSON representation
This is a take-home assignment for a job
- Host: GitHub
- URL: https://github.com/tylher/fullstack-test
- Owner: tylher
- Created: 2023-12-12T21:41:12.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-12-20T18:10:10.000Z (over 1 year ago)
- Last Synced: 2025-02-03T09:23:38.059Z (4 months ago)
- Language: Java
- Homepage: https://fullstack-test-pearl.vercel.app
- Size: 1020 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Live](#Live)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [📝 License](#license)
This is a task given to showcase my fullstack skills
> Major technologies used in this project:
Backend Server
Database
Frontend server
Frontend Framework
[//]: # ()
> These are key features of this project.
- **user registers with their info about their name and sector**
- **A page to list the users and users can edit their info during their respective sessions**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- Spring boot
- java
- react
- sql
- maven
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone [email protected]:tylher/fullstack-test.git
```
### Install
Install this project with:
> Open the cloned project on Intellij IDE and hit the run button to spin up Tomcat server and database.
```sh
cd backend
mvn spring-boot:run
```
### Usage
To run the project, execute the following command:
> Test the API end points on API clients such as RapidAPI, Postman etc.
>Run the user interface following the following steps
```sh
cd frontend
npm install
npm run
```
### Usage
Test live demo [here](https://fullstack-test-azure.vercel.app/)
[//]: # (To run read documentation for each endpoints :)
[//]: # ()
[//]: # (> Navigate to localhost:8080/swagger-ui/index.html
)
[//]: # (> input "/v3/api-docs" in the explore search box)
[//]: # (
)
👤 
- GitHub: [@tylher](https://github.com/tylher)
- Twitter: [@tylher123](https://twitter.com/tylher123)
- LinkedIn: [Taiwo Adediran](https://www.linkedin.com/in/taiwo-adediran-327654127/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project or have any comment about it feel free to chat me up.
This project is [MIT](./MIT.md) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._