Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/adam-robson/flags

A catalog of every ISO2 country in the world represented by flag.
https://github.com/adam-robson/flags

javascript nodejs postgresql supabase-js typescript vite vitest

Last synced: 3 months ago
JSON representation

A catalog of every ISO2 country in the world represented by flag.

Awesome Lists containing this project

README

        

# Flags

## Description

This is a full-stack web application built with [React](https://react.dev/),
and bootstrapped with [Vite](https://vitejs.dev/). It uses
[Supabase](https://supabase.com/) for a [Postgres](https://www.postgresql.org/)
database and it displays a searchable list of the flags for every country in the
world.

## Table of Contents

- [Flags](#flags)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Summary](#summary)
- [Features](#features)
- [Technologies](#technologies)
- [Run Locally](#run-locally)
- [Authors](#authors)
- [Contact](#contact)

## Summary

This project was started as part of my time in the July 2022 cohort at Alchemy
Code Lab, in Portland, Oregon. I have since updated it multiple times so that
the project remains current with ECMAScript. I also integrated TypeScript.

## Features

An exercise in making API calls, handling the returned data, and filtering
state.

## Technologies

- JavaScript
- TypeScript
- JSX
- CSS
- React
- ESLint
- Supabase

## Run Locally

The following steps will run the project in the *development* mode:

1. Clone the project: `$ git clone https://the-project`

2. Go to the project directory: `$ cd the-project`

3. Install dependencies: `npm install`

4. Start the server: `npm run dev`

5. Open `http://localhost:5173` to view it in the browser.

The page will reload if you make edits,
and any lint errors will appear in the console.

## Authors

> [@Adam-Robson](https://www.github.com/Adam-Robson)

## Contact

I can be reached by email to `[email protected]`.