Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adam014/ramble
Ramble is your personal passport to the planet's price tags.
https://github.com/adam014/ramble
javascript jest nextjs react supabase tailwindcss typescript
Last synced: 3 months ago
JSON representation
Ramble is your personal passport to the planet's price tags.
- Host: GitHub
- URL: https://github.com/adam014/ramble
- Owner: Adam014
- Created: 2023-11-01T21:07:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-19T21:54:47.000Z (5 months ago)
- Last Synced: 2024-08-20T01:55:39.028Z (5 months ago)
- Topics: javascript, jest, nextjs, react, supabase, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://ramble-blond.vercel.app
- Size: 72.1 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ramble
Ramble is your personal passport to the planet's price tags. It's not just a web app; it's a whisperer for your wallet. Real-time data, tailor-made recommendations, and a community of kindred travelers make Ramble your go-to guide for worldly adventures without the financial fuss.
## Badges
[](https://choosealicense.com/licenses/mit/)
## Getting Started
1. First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file.
## Run Locally
Clone the project
```bash
git clone https://github.com/Adam014/Ramble.git
```
Go to the project directory
```bash
cd ramble
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
## Color Reference
| Color | Hex |
| ----------------- | ------------------------------------------------------------------ |
| Background_color |  #000000 |
| Button_color |  #F13E51 |
| Hover_color |  #E08C9C |
| Tag_color |  #001a64 |
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
NEXT_PUBLIC_RAPIDAPID_KEY = your_RAPIDAPI_key
NEXT_PUBLIC_SUPABASE_ANON_KEY = your_SUPABASE_key
NEXT_PUBLIC_SUPABASE_APP_URL = your_SUPABASE_url
## API Reference
#### Get the details of the city
```http
GET /map/${country}/${capital}
```
## Summary
Defines three asynchronous functions to fetch city data from a Supabase database. The functions handle fetching data for a specific page number, a specific city, and all cities within a specific country.
## Example Usage
```js
const pageNumber = 1;
const citiesData = await fetchCitiesData(pageNumber);
console.log(citiesData);
const country = 'USA';
const city = 'New York';
const cityData = await fetchCityData(country, city);
console.log(cityData);
const citiesByCountry = await fetchCitiesByCountry(country);
console.log(citiesByCountry);
```
## Code Analysis
1. Inputs
- pageNumber: A number representing the page of data to fetch.
- country: A string representing the country name.
- city: A string representing the city name.
2. Flow
- fetchCitiesData checks for existing data for a given page number and returns it sorted by rank.
_ fetchCityData fetches data for a specific city and country.
- fetchCitiesByCountry fetches all cities data for a specific country.
3. Outputs
- fetchCitiesData: Returns sorted city data for the given page number or null if an error occurs.
- fetchCityData: Returns data for the specified city or null if not found or an error occurs.
- fetchCitiesByCountry: Returns an array of cities data for the specified country or an empty array if not found or an error occurs.
## Authors
- [@kindast](https://www.github.com/kindast) - Fullstack Developer
## Tech Stack
**Client:** Next.js (both Typescript and Javascript for the map), TailwindCSS, Jest
**Database:** Supabase
## 🔗 Links
[](https://www.linkedin.com/in/adam-stádník-271280218/)
[](https://twitter.com/kindastcs)
## Contributing
Contributions are always welcome!
## Support
For support, email [email protected] or contact me via the web!
## Feedback
If you have any feedback, please reach out to me at [email protected]