Skip to content

Latest commit

 

History

History
85 lines (55 loc) · 2.98 KB

README.md

File metadata and controls

85 lines (55 loc) · 2.98 KB
Raw

Udayah

Welcome to Udayah!

We invite all open-source enthusiasts to join us in building a free platform for job seekers. In a world where many services for resumes, job emails, and related resources often come at a cost, Udayah stands out as a free, open-source alternative. Whether it’s adding new features, reporting issues, or suggesting improvements, your contributions can help make Udayah a valuable resource for job seekers.

Before contributing, kindly outline the use case, benefits, and goal of your proposed feature or changes. Together, let’s build something meaningful, accessible, and free for everyone!

Tech Stack

  • Frontend: Flutter
  • Backend: Node.js, Firebase, Aws

Local Setup

Flutter Setup

  1. Install Flutter by following the official Flutter documentation.
  2. Configure your own Firebase setup and link it to the project.
  3. Navigate to the lib/ folder in the Flutter project for development.

Node.js Setup

  1. Navigate to the functions/ folder which contains the backend logic.

  2. To set up the email-sending feature, follow these steps:

    • Create an email.json file in the functions/ directory.
    • Add emails in the following format (up to 15 emails): 
      [
  {
    "email_id": "00001",
    "email_address": "[email protected]",
    "added_by": "admin"
  },
  ...
]

  3. Create a .env file in the functions/ folder and define the ENCRYPTION_KEY. Make sure this matches the key used in Flutter (see details below).

Encryption Setup

In the Flutter project, go to lib/encryption.dart and ensure that the encryption key matches the one defined in your .env file in the Node.js backend. The key can be set like this in Flutter:

static final key = encrypt.Key.fromUtf8("your key"); // Ensure this is the same as in Node.js

Backend Setup

  1. In the functions/ folder, ensure you have Node.js installed. If not, you can download and install it from the official Node.js website.

  2. Once Node.js is installed, open a terminal and navigate to the functions/ folder.

  3. Run the following command to install the required dependencies:

    npm install

  4. After installation, start the backend server by running:

    npm start

  5. Ensure that the server is running properly and that you can access the API endpoints.

Update Flutter API Endpoint

In the Flutter project, navigate to lib/data/constant.dart and update the backend API endpoint to match your local or hosted server.

Contributing

  • Please open an issue before submitting pull requests.
  • Clearly explain the use case, benefits, and goals for any new feature or fix.
  • Respect the coding standards and maintain consistency in the codebase.

We look forward to your contributions!

Happy coding!

Support

For any kind of support, please reach out to us at: Email: [email protected]