Travail🏠

Travail is a web platform that facilitates buying, selling, and renting houses. It provides a user-friendly interface for users to explore listings, contact agents, and for admin or agents to manage their properties.

Requirements

• Node.js - JavaScript Runtime
• Svelte - JavaScript framework
• SvelteKit - JavaScript Metaframework built with Svelte
• DrizzleORM - TypeScript ORM
• UnoCSS or TailwindCSS - CSS frameworks
• Zod - TypeScript validation library

Tools/Frameworks Used

• Frontend:

  • Svelte
  • UnoCSS
  • Chart.js
  • Zod

• Backend:

  • SvelteKit
  • DrizzleORM
  • SQLite
  • Argon2 (password hashing)

Getting Started

Follow these steps to set up and run the Travail project locally:

1. Clone the Repository

git clone https://github.com/sparrowsl/travail.git
cd travail

2. Install Dependencies

npm install

3. Configure Environment Variables

Create a .env file in the root directory and set the following variables:

DATABASE_URL="./database.db"
JWT_SECRET_KEY="superdumblongsecretkey"

Adjust the values according to your environment.

4. Setup database tables

npm run db:setup

# > A default admin account will be created with the credentials
# > Email: admin@mail.com
# > Password: password

run npm run db:studio to add data manually in the database (use for creating new admin only)

5. Run the Application

npm run dev

Visit http://localhost:5173 in your browser to see the Travail in action.

Contributing

Feel free to contribute to the project by opening issues or submitting pull requests. Any enhancements or bug fixes are welcomed.

License

This project is licensed under the MIT License.