https://github.com/michojekunle/amala-atlas
https://github.com/michojekunle/amala-atlas
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/michojekunle/amala-atlas
- Owner: michojekunle
- Created: 2025-09-13T11:03:54.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-09-13T16:04:39.000Z (about 1 month ago)
- Last Synced: 2025-09-13T18:18:18.353Z (about 1 month ago)
- Language: TypeScript
- Homepage: https://amalaatlas.vercel.app
- Size: 2.17 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# amala-atlas
amala-atlas (Amala at last) is an open-source platform designed to help users discover, track, and share their favorite amala spots.
It provides an API backend and extensible features to support food discovery, ratings, and more.
## Features
- RESTful API for managing Amala spots and reviews
- Easy integration with third-party clients
- Extensible backend for new features
- An installable web application(PWA) on any platform, web, mobile, Android, IOS.
- Clean and intuitive User interface for users
- AI-powered search and verification
- AI chatbot to find Amala spots around
## Getting Started
### Prerequisites
- [Node.js](https://nodejs.org/) (v20 or later)
### Installation
Clone the repository:
```bash
git clone https://github.com/michojekunle/amala-atlas.git
cd amala-atlas
```
Install dependencies:
```bash
# Using pnpm
pnpm install
# Using npm
npm install
# Using yarn
yarn install
```
### Usage
Start the backend server:
```bash
pnpm dev
# or
npm run dev
# or
yarn dev
```
The API server will run on [http://localhost:3000](http://localhost:3000) by default.
### Configuration
- Edit environment variables in `.env` as needed.
- See [backend/README.md](backend/README.md) for backend-specific details.
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository
2. Create a new branch (`git checkout -b feature-xyz`)
3. Make your changes
4. Commit and push (`git commit -m "Add feature xyz"`)
5. Open a pull request
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
## License
This project is licensed under the [MIT License](LICENSE).
---
For questions, suggestions, or bug reports, please open an issue or contact the maintainers.
Thank you :)