Skip to content
This repository has been archived by the owner on Sep 16, 2024. It is now read-only.

Latest commit

 

History

History
61 lines (40 loc) · 3.29 KB

README.md

File metadata and controls

61 lines (40 loc) · 3.29 KB
Raw

Bring your own Photo Blog (BYOPB)

Host your own simple and elegant platform for sharing and exploring photos.

Project Header Image

BYOPB is designed as a user-friendly web application for showcasing photos and allowing users to explore posts by tags. It offers an intuitive interface displaying photos in a grid format. The application supports user authentication, enabling designated posters to create new posts, while other users can engage by commenting on posts.

Technologies

The project utilizes a blend of modern technologies for ease of development and deployment:

Deployment

To deploy your personalized instance, follow these steps:

  1. Fork Repository: Fork the repository to your GitHub account.

  2. Configure Project Details:

    • Change the following details in the code:
      • Edit the blog title, description, author and domain in the .env file.
      • Tailwind color theme in tailwind.config.js.
      • Default fonts in /src/styles/fonts.ts.

  3. Deploy AWS Stack: Deploy the AWS CloudFormation stack provided in the repository. This will create the necessary infrastructure for the back end. Generate an access key for the user created by the stack. To optionally enable automatic redeployment on stack changes, enable the GitHub workflow in the repository.

  4. Set Environment Variables:

    • In your local environment or on Vercel, set the following environment variables:
      • AWS Variables:
        • AWS_ACCESS_KEY_ID: Set to the generated access key.
        • AWS_SECRET_ACCESS_KEY: Set to the corresponding secret key.
        • AWS_REGION: Set to the region where the stack was deployed.
        • AWS_RESOURCE_PREFIX: Set to the stack name.
      • Google OAuth Variables: Configure Google OAuth 2.0 credentials for authentication, and set the following variables:
        • GOOGLE_CLIENT_ID: OAuth credentials for authentication.
        • GOOGLE_CLIENT_SECRET: Secret key for OAuth credentials.
      • NextAuth Variables:
        • NEXTAUTH_SECRET: Set to a random string.
      • Analytics Variables (Optional):

  5. Deploy Frontend: Deploy the NextJS frontend on Vercel by importing the repository. Set the above environment variables in the Vercel project settings.

  6. Create Admin User: Create an admin user by navigating to the /admin endpoint of your deployed frontend. The first user to sign in will be designated as the admin user and will have the ability to create new posts and manage other users.

License

This project is licensed under the MIT License.

Collaboration

We welcome collaboration and contributions to enhance the BYOPB project. Feel free to fork the repository, make improvements, and submit pull requests. Let's make this platform even better together!