Welcome to Techwave Writers! This repository contains the frontend code for the Writers portal of Techwave Writers. The portal allows writers to manage their work, see available assignments, view notifications, and much more.
- Account management: Registration, login, forgot password, email otp verification e.t.c
- Home Page Feed: View available work in a feed and view details.
- Work Management: Take up work and view assigned work.
- Bookmarking: Bookmark work for later reference.
- Submitting: Submit work for review by admins after completion.
- Profile Management: Update profile information, view analytic, change password e.t.c
- Search and Filter: Search for work and apply various filters.
- Notifications: Receive notifications for assigned work, work nearing deadlines, etc.
- Responsive Design: Optimized for both mobile and desktop.
- Dark Mode Support
- React: For building the user interface.
- Tailwind CSS: For styling the components.
- React Router: For navigation.
- Axios: For making HTTP requests.
- Context API: For state management.
To get a local copy up and running, follow these simple steps:
- Node
-
Clone the repository:
git clone https://github.com/SamuelMaiko/academic-writing-frontend.git
-
Navigate to the project directory:
cd academic-writing-frontend -
Install the dependencies:
npm install
-
Start the development server:
npm run dev
-
Open your browser and navigate to:
http://localhost:5173 -
To build the project for production:
npm run build
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (git checkout -b feature/AmazingFeature)
- Commit your Changes (git commit -m 'Add some AmazingFeature')
- Push to the Branch (git push origin feature/AmazingFeature)
- Open a Pull Request
If you have any questions about the codebase or encounter issues while working on it, feel free to reach out for assistance. Here are some ways to get support:
- Contact: You can reach out to Maiko for assistance or clarification on any aspect of the code.
- Documentation: Refer to the project's documentation for guidance on setup, usage, and troubleshooting.
- Issue Reporting: If you encounter bugs or unexpected behavior, please report them by opening a new issue in the GitHub Issues section of this repository. Provide as much detail as possible, including steps to reproduce the issue, your environment, and any relevant logs or screenshots.
We're here to help ensure a smooth experience with the codebase and to address any questions or concerns you may have.
This project is licensed under the MIT License - see the LICENSE file for details.
Created by Maiko - feel free to contact me!