Skip to content
Asia K edited this page Apr 23, 2023 · 17 revisions

Welcome to the FloralFlow Wiki!

Introduction

  • Overview of FloralFlow
  • Benefits of using FloralFlow
  • Supported platforms and technologies
  • Links to installation and setup instructions

Getting Started

  • Installation instructions

  • Creating a new project

  • Setting up the development environment

  • Overview of project structure

  • Running the application

  • Configuring hosting for a Next.js application with Firebase (if applicable)

    • Using client-side routing
    • As a single-page app when configuring Firebase Hosting
    • Set up automatic builds and deploys with GitHub
    • Create a service account with Firebase Hosting admin permissions
    • Upload the service account JSON to Github as a secret named FIREBASE_SERVICE_ACCOUNT_FLORALFLOW
    • Use the Firebase CLI in your GitHub Actions workflow to deploy your application automatically
    • Choose whether to set up a build script to run before each deployment
      • If so, use the script "npm ci && npm run build" to ensure that your application is built and optimized before each deployment
      • [¡IMPORTANT] visit the URL provided to revoke authorization for the Firebase CLI GitHub OAuth App. This ensures that the Firebase CLI no longer has access to your GitHub account.
  • Vercel Deployment COMPLETE

  • analytics config

  • [] Firebase - IN PROGRESS

Architecture

User Interface

  • Accessibility considerations
  • Overview of the UI
  • Available components and features
  • Customization options
  • Handling user input and events

Backend

  • Overview of the backend
  • APIs and services
  • Data storage and retrieval
  • Authentication and authorization
  • Integration with third-party services

Testing

  • Overview of testing in FloralFlow
  • Types of tests (unit, integration, end-to-end)
  • Setting up a test environment
  • Writing and running tests

Troubleshooting

  • Common issues and solutions
  • Debugging techniques
  • Error messages and how to interpret them

Contributing

  • Guidelines for contributing to FloralFlow
  • How to submit bug reports and feature requests
  • How to submit code changes
  • Code review process

Resources

  • Links to documentation, tutorials, and other helpful resources
  • Community forums and support channels
  • List of third-party libraries and tools compatible with FloralFlow

Conclusion

  • Summary of key points
  • Future development plans
  • Contact information for project maintainers.