Compatriots

A web application for informing people about local Nigerian laws.

Features

• Interactive chatbot interface
• Multi-language support
• State/region selection
• Modern web interface built with React
• Webpack bundling for development and production

Project Structure

Compatriots/
├── src/                    # Source code
│   ├── components/        # React components
│   │   ├── ChatBot.js    # Main chatbot interface
│   │   ├── LanguageSelector.js  # Language selection component
│   │   ├── StateSelector.js     # State/region selection
│   │   └── states.js     # State data
│   ├── styles/           # CSS styles
│   │   └── App.css      # Main application styles
│   ├── App.js           # Main application component
│   └── index.js         # Application entry point
├── public/               # Public assets
│   ├── index.html       # Main HTML file
│   ├── styles.css       # Global styles
│   ├── main.js          # Main JavaScript bundle
│   └── bundle.js        # Webpack bundle
├── server.js            # Node.js server
├── webpack.config.js    # Webpack configuration
├── package.json         # Node.js dependencies
└── test-*.js           # Test files

Getting Started

Prerequisites

• Node.js (v14 or higher)
• npm or yarn

Installation

1. Clone the repository:

   git clone <repository-url>
   cd Compatriots

2. Install dependencies:

   npm install

3. Start the development server:

   npm start

4. Open your browser and navigate to http://localhost:3000

Development

Available Scripts

• npm start - Start the development server
• npm run build - Build the project for production
• npm test - Run tests

Building for Production

npm run build

This will create optimized bundles in the public/ directory.

Technologies Used

• Frontend: React.js
• Build Tool: Webpack
• Server: Node.js with Express
• Styling: CSS3
• Package Manager: npm

Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions or support, please open an issue in the repository.