https://github.com/onukwilip/capital-placement-task-1
This is the repository which holds the first task assigned to me by Capital placement
https://github.com/onukwilip/capital-placement-task-1
capitalplacement
Last synced: about 1 month ago
JSON representation
This is the repository which holds the first task assigned to me by Capital placement
- Host: GitHub
- URL: https://github.com/onukwilip/capital-placement-task-1
- Owner: onukwilip
- Created: 2023-09-26T23:33:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-27T16:51:35.000Z (over 1 year ago)
- Last Synced: 2025-01-18T05:27:11.153Z (3 months ago)
- Topics: capitalplacement
- Language: TypeScript
- Homepage: https://capital-placement-task-1.vercel.app/
- Size: 340 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CAPITAL PLACEMENT TASK 1
This is the first task (Task 1) of the interview assessment assigned to me by captial placement for the role of a frontend developer. The project was developed using the following tools:
- React Js
- Typescript
- SCSS
- Material UI
- Docker
## HOW TO USE
- **Run the project directly on your system**:
> To run this project directly on your system you will need [**Node.Js**](https://nodejs.org/en/download) version **16.15.0** or higher
- Run `git clone https://github.com/onukwilip/capital-placement-task-1.git`
- Run `npm i -f` (To install all dependencies)
- Run `npm run build` (To create the production build)
- Run `npm i -g @stoplight/prism-cli` (To install Prism)
- Run `npx prism mock ./prism-demo.yaml` (Start the prism server to mock the API endpoints)
- Run `npm i -g serve` (Install the library responsible for serving the production build)
- Run `npx serve -s build` (Serve the application on http://localhost:3000)
**N.B: Make sure to fill the following environmental variables with the URL of the Prism mock server when running the project locally: `API_GET_ENDPOINT`, `API_PUT_ENDPOINT`**
- **Run the project using Docker**:
> To run this project as a container you will need [**Docker**](https://www.docker.com/products/docker-desktop/)
- Run `git clone https://github.com/onukwilip/capital-placement-task-1.git`
- Run `docker build -t cp-task-1 .`
- Run `docker run -p 3000:3000 -rm -it cp-task-1`
- Run `docker build -t d-prism . -f .\prism.Dockerfile`
- Run `docker run -p 4010:4010 --rm d-prism`