https://github.com/myonaingwinn/myanmar-postal-code
Search for Postal Code (Myanmar only). You can search with English or Myanmar inputs. Have a nice day!
https://github.com/myonaingwinn/myanmar-postal-code
docker docker-compose element-ui expressjs makefile mongodb nodejs pinia vuejs2
Last synced: 2 months ago
JSON representation
Search for Postal Code (Myanmar only). You can search with English or Myanmar inputs. Have a nice day!
- Host: GitHub
- URL: https://github.com/myonaingwinn/myanmar-postal-code
- Owner: myonaingwinn
- Created: 2023-01-16T07:13:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-15T08:40:02.000Z (about 3 years ago)
- Last Synced: 2025-01-08T09:11:26.753Z (over 1 year ago)
- Topics: docker, docker-compose, element-ui, expressjs, makefile, mongodb, nodejs, pinia, vuejs2
- Language: JavaScript
- Homepage: https://mm-postal-code.vercel.app
- Size: 823 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
# Environment Setting without using Docker
## Requirements
1. [node](https://nodejs.org)-16 and above
1. [MongoDB](https://www.mongodb.com) account (free)
## Project Setup
### Frontend
#### Install packages
```sh
cd frontend && npm i
```
#### Copy .env file and set your Env data
```sh
cp .env.example .env
```
### Server
#### Install packages
```sh
cd server && npm i
```
#### Copy .env file and set your Env data
You'll need MongoDB configurations. Go [there](https://www.mongodb.com) and create Cluster, DB, etc.,.
```sh
cp .env.example .env
```
## Run
### Frontend
```sh
cd frontend && npm run dev
```
### Server
```sh
cd server && npm run dev
```
# Environment Setting using Docker
## Requirements
1. [Docker](https://www.docker.com/products/docker-desktop)
1. [Make](https://www.gnu.org/software/make)
## Project Setup
```sh
make setup
```
### Set Env data
Set necessary data in both of the following .env files.
- `frontend/.env`
- `server/.env`
## Run
```sh
make up
```
**That's all!**
> Take a look other _Make_ commands in [this](./Makefile) Makefile
# Troubleshooting
If you encounter any issues during the setup or running of the application, you can refer to the following troubleshooting tips:
- Failure of `make setup` command: If the `make setup` command fails, you can try deleting the `node_modules` folder in both the `frontend` and `server` directories. After deleting the folders, run the `make setup` command again.
- CORS error: If you come across a CORS (Cross-Origin Resource Sharing) error, ensure that you have entered the URL of your frontend application in the `ALLOWED_ORIGIN` configuration variable in the `server/.env` file. This allows the server to accept requests from it.
> If you encounter any other bugs or issues while using the application, please help me improve it by opening a new issue [here](https://github.com/myonaingwinn/myanmar-postal-code/issues/new). I appreciate your feedback and will work towards resolving any reported problems.\
> \
> Feel free to reach out if you have any further questions or concerns.