weaponsforge/my-phonebook repository overview

⁠my-phonebook

Latest frontend (client) and backend (server) local development images of the my-phonebook web app, an online multi-user web application clone of a regular Contacts application using NextJS, Express and Firebase.

Live Preview
https://weaponsforge.github.io/my-phonebook/⁠

GitHub Repository
https://github.com/weaponsforge/my-phonebook⁠

⁠Basic Usage

1. Pull the "latest" client and server development images.

   docker pull weaponsforge/my-phonebook:client
   docker pull weaponsforge/my-phonebook:server
   

   Copy

2. Create .env files for the client and server.

   • Visit the client/README.md and server/README.md files of the my-phonebook⁠ GitHub repository for more information about the .env file contents.

3. Spin up the client and server containers with:

   docker run -it --rm -p 3000:3000 --env-file .env weaponsforge/my-phonebook:client
   docker run -it --rm -p 3001:3001 --env-file .env weaponsforge/my-phonebook:server
   

   Copy

4. Load the localhost website at:
   http://localhost:3000

⁠Usage with Docker Compose

1. Clone the my-phonebook⁠ repository.
   git clone https://github.com/weaponsforge/my-phonebook.git

2. Navigate to the cloned my-phonebook root project directory, then run:
   docker compose -f docker-compose.dev.yml pull

3. Set up the environment variables for the /client and /server directories.

   • Visit the my-phonebook client/README.md and server/README.md files for more information.
   • Take note of the .env variables setup for Windows and Linux to enable hot reload.

4. Run the development images.
   docker compose -f docker-compose.dev.yml up

5. Load the localhost website at:
   http://localhost:3000