Skip to content

Latest commit

 

History

History
112 lines (73 loc) · 4.23 KB

README.md

File metadata and controls

112 lines (73 loc) · 4.23 KB
Raw

Greensfeer (Server Side)

Greensfeer Server is the backend component of the Greensfeer project, providing essential services and APIs to support the functionality of the Greensfeer online marketplace. This server is responsible for handling authentication, data storage, and various backend operations.

Credits

Web Developers

Technologies Used

The Greensfeer Server utilizes the following technologies and dependencies:

  • Express: A fast and minimalist web framework for Node.js.
  • Firebase: A development platform with a wide range of services.
    • Authentication: Firebase Authentication for user authentication.
    • Firestore Database: A NoSQL cloud database for storing application data.
    • Firebase Storage: For managing and serving user-generated content.
    • Firebase Analytics: To gain insights into user behavior and app usage.
    • Firebase Admin: A set of tools for managing Firebase services programmatically.
    • Firebase Functions: Serverless functions to extend and customize Firebase services.
  • body-parser: Middleware for parsing request bodies.
  • cookie-parser: Middleware for parsing cookies.
  • cors: Middleware for enabling Cross-Origin Resource Sharing.
  • csurf: Middleware for adding CSRF protection to routes.
  • ejs: A simple templating engine for rendering dynamic content.
  • uuid: A library for generating UUIDs (Universally Unique Identifiers).

Getting Started

To set up and run the Greensfeer Server locally, follow these steps:

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/IanDCF/greensfeer-be.git

  2. Change to the project directory:

    cd greensfeer-be

  3. Install the project dependencies:

    npm install

Configuration

  • Set up your Firebase project and obtain the necessary configuration keys.
  • Configure your Firebase project by creating a keys.json file following the keys.example.json file format.

Server Hosting

The Greensfeer Server is hosted using Firebase Functions. Firebase Functions is a serverless compute service that allows you to run backend code in response to HTTP requests or other events. This approach provides scalability, reliability, and easy deployment for the server component of Greensfeer.

Local Development

During local development, you can use the Firebase Emulator Suite to test your functions locally before deploying them to the cloud. To start the emulator suite, use the following command:

npm run serve

Deployment

You can deploy the Greensfeer Server to your preferred hosting platform or use Firebase Hosting and Cloud Functions for deployment. Ensure that you have the Firebase CLI configured for deployment.

To deploy to Firebase, use the following command:

npm run deploy

Usage

The Greensfeer Server provides a set of APIs and services that are utilized by the Greensfeer front-end UI.

Contributing

We welcome contributions to the Greensfeer Server. If you'd like to contribute, please follow the standard GitHub workflow:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear, concise messages.
  4. Push your branch to your fork on GitHub.
  5. Create a pull request (PR) to the main repository.
  6. Engage in discussions and address feedback during the review process.
  7. Once approved, your changes will be merged into the main branch.

Thank you for contributing to Greensfeer!

License

This project is licensed under the MIT License.

© 2023 Greensfeer. All Rights Reserved.