An open API service indexing awesome lists of open source software.

https://github.com/teekaytech/coinsolv-assessment


https://github.com/teekaytech/coinsolv-assessment

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Coinsolv Assesssment

> I used [Vite](https://github.com/nexys-system/boilerplate_vite/) template and [`countries-list`](https://www.npmjs.com/package/countries-list) package to create a simple table that displays all the countries of the world, with the `name`, `capital`, `display flag`, and `link to wiki page` columns. I also added a basic search functionality to the app.

## Built with

- Vite React template
- TypeScript
- Bootstrap 5
- Git/GitHub
- [![Netlify Status](https://api.netlify.com/api/v1/badges/c4c7a88b-ba77-4896-b016-80989a94e7c1/deploy-status)](https://app.netlify.com/sites/coinsolv/deploys)

## Live demo: [Live Demo Link](https://coinsolv.netlify.app)

## Getting started

To get a local copy up and running follow these simple example steps.

- On the project GitHub page, navigate to the main page of the repository [this page](https://github.com/teekaytech/coinsolv-assessment).
- Under the repository name, locate and click on a green button named `Code`.
- Copy the project URL as displayed.
- If you're running Windows Operating System, open your command prompt. On Linux, Open your terminal.
- Change the current working directory to the location where you want the cloned directory to be made. Leave as it is if the current location is where you want the project to be.
- Type `git clone`, and then paste the URL you copied in Step 3.

```
$ git clone https://github.com/teekaytech/coinsolv-assessment.git
```
- Press Enter. Your local copy will be created.

Please Note that you must have Git installed on your PC, this can be done [here](https://gist.github.com/derhuerst/1b15ff4652a867391f03).

### Prerequisites

- Node
- NPM / NPX
- Web Browser
- Text Editor (VSCode, Notepad++)

### Setup Scripts

Change working directory to the project's root directory on the terminal, install dependencies with: `yarn install`

In the project directory, you can run: `yarn start`

Runs the app in the development mode.

Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload when you make edits.

Script `yarn build` builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

## Author

**Taofeek OLALERE**

- [Portfolio](https://taofeekolalere.me)
- [Github](https://github.com/teekaytech/)
- [Twitter](https://twitter.com/ola_lere)
- [LinkedIn](https://www.linkedin.com/in/olaleretaofeek/)

## Contributing

Contributions, issues and feature requests are welcome!

1. Fork the Project: https://github.com/teekaytech/coinsolv-assessment
2. Open a Pull Request

Feel free to check the [issues page](https://github.com/teekaytech/coinsolv-assessment/issues).

## Show your support

Give a :star: if you like this project!

## Acknowledgements

- [FreeCodeCamp TypeScript Crash Course](https://www.freecodecamp.org/news/learn-typescript-with-this-crash-course/)
- [Vite Template](https://github.com/nexys-system/boilerplate_vite/)