A platform for devs and students to collaborate on projects or research.
- Share a post with idea and possible stack, including experience level and tags. A brief intro for ideas is also required.
- Profile with experience level and tags to improve recommendation system and search results.
- People can apply to posts, and the sender can review the profile of the people who applied.
- Sender can take as many people as they want. Once their application is accepted by the sender, they can now see the discord/slack link to talk to the sender about the project.
- FE: React/Next, daisyUI, tailwind
- Backend: Nest (Render), Prisma, PSQL
- Make sure to have the following installed:
- node 16+
- make
- docker
- docker compose
- Run
maketo setup environment and migrate db. - Run
make devto start development environment [both frontend and backend]. - Run
make backendto run server [dev mode] and db,make frontendto run frontend [dev mode]. - Run
make prodto start production environment. - Run
make logsfor logs. (make logs c=backendfor logs of backend). - Run
make reloadto restart containers. (make reload c=backendormake reload c=ourcode-db). - Run
make downto stop and remove the containers.
Make sure you have nodejs 16+ and docker installed.
- You can run
.\setup.batto setup environment variables and migrate the db. - And then
.\dev.batto start the db and both backend and frontend servers. .\prod.batcan be used to demo the production environment.docker compose downto stop the database.
You can also use the make build system if you want but this should be perfectly fine for now.
This provides more convenient approach but has some installation overhead.
- Install the Cygwin terminal.
- Make sure to install make at time of installation of cygwin.
- In the cygwin terminal,
cdto the working directory. - Follow the commands at the linux section.
If these techniques do not work on your windows pc, try the following:
- In the cygwin terminal, run
maketo migrate the db. - Run
make windowsto start the db and backend server. - Run
make downto stop the db container.
- All code should be reviewed by peer
- Understandable commit messages
- Will be using the GitHub Flow branching system to manage codebase
- Main branch is the production branch
- To add features or bug fixes, create a new branch for it