https://github.com/techlism/odoo_hackathon
https://github.com/techlism/odoo_hackathon
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/techlism/odoo_hackathon
- Owner: techlism
- Created: 2024-06-29T03:39:48.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T11:10:21.000Z (over 1 year ago)
- Last Synced: 2025-04-01T03:51:10.210Z (over 1 year ago)
- Language: TypeScript
- Size: 5.39 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Test Secure
Test Secure is a secure, web-based application designed for efficient and reliable management of [describe the purpose, e.g., testing or assessment workflows]. Developed for the Odoo Hackathon, this project emphasizes streamlined collaboration between client and server components, utilizing modern web technologies.
## Project Structure
This repository consists of two primary components:
1. **Client** - Built with Next.js, this frontend interface provides a responsive and intuitive user experience.
2. **Server** - Powered by Node.js and Express, the backend handles secure data transactions, API routing, and business logic.
### Directory Breakdown
- **Client**: `/client`
- `components/`: Reusable React components for a modular frontend.
- `app/`: Main application files.
- `public/`: Static assets.
- `package.json`: Project dependencies and scripts.
- `tailwind.config.ts`: Tailwind CSS configurations for styling.
- **Server**: `/server`
- `controllers/`: Business logic for various endpoints.
- `routes/`: API routes for client-server communication.
- `models/`: Database schema definitions.
- `utils/`: Utility functions.
- `config/`: Configuration files for server settings.
## Getting Started
### Prerequisites
Ensure you have the following installed:
- Node.js (v14 or higher)
- npm (v6 or higher)
- MongoDB or another database (based on configurations)
### Installation
1. **Clone the repository**:
```bash
git clone https://github.com/techlism/odoo_hackathon.git
cd test-secure
```
2. **Install dependencies** for both client and server:
```bash
cd client
npm install
cd ../server
npm install
```
3. **Environment Variables**:
- Set up environment variables as per the `config/` directory requirements.
### Running the Application
To run both the client and server:
1. **Server**:
```bash
cd server
npm start
```
2. **Client**:
```bash
cd client
npm run dev
```
Access the application via [http://localhost:3000](http://localhost:3000).
## Features
- **User Authentication**: Secure login and registration.
- **Data Management**: CRUD operations for managing [data type, e.g., assessments].
- **Real-Time Collaboration**: Synchronized updates between clients.
## Technologies Used
- **Frontend**: Next.js, React, Tailwind CSS
- **Backend**: Node.js, Express.js, MongoDB
## Contributing
1. Fork the repository
2. Create your feature branch:
```bash
git checkout -b feature/YourFeature
```
3. Commit your changes:
```bash
git commit -m 'Add YourFeature'
```
4. Push to the branch:
```bash
git push origin feature/YourFeature
```
5. Open a pull request.