Shulutions Open Source is a full-stack web application built using Angular and NestJS. The purpose of this application is to provide a platform for users to share, discuss, and manage open-source projects efficiently.
This README.md file contains the necessary information for setting up and running the Shulutions Open Source application on your local machine.
Shulutions Open Source supports 4 types of users, each with specific features and capabilities:
- View project ideas and comments
- View information about the current open-source projects
- Join the sub-community of the open-source projects they are interested in
- Register for an account
- Login to their account
- Post new project ideas
- Vote for their favorite project ideas
- Comment on project ideas
- Update profile details
- Update the details of the projects they are managing
- View and update all projects on the system
- View and delete project ideas
- Manage the projects that are displayed on the website
Before you begin, ensure you have the following installed on your local machine:
- Node.js
- npm
- Angular CLI
- NestJS CLI
- Clone the repository:
git clone https://github.com/yourusername/shulutions.git
cd shulutions- Install the dependencies for both the frontend and backend:
cd frontend
npm install
cd ../backend
npm install- Configure the environment variables:
Create a .env file in the /backend directory and configure the necessary environment variables (e.g., database credentials, JWT secret, etc.).
- Start the NestJS backend:
cd backend
npm run start:devThe backend server should now be running on http://localhost:3000.
- Start the Angular frontend:
cd ../frontend
ng serveThe frontend application should now be running on http://localhost:4200.
If you encounter any issues or have any questions about the project, please create an issue or contact the project maintainers.
Happy coding!