Collabrate your ideas with your team!
View Demo (backend not working because heroku :()
·
Report Bug
·
Request Feature
Table of Contents
There is a lot of projects for keeping track of ideas, daily tasks or development process. Inventum is one of them. It is never intended to be a real competitor for the websites like Trello vs., but it is a fun project where one can apply what they learned and also create and improve a real application.
Here's why you should use Inventum:
- Fully customizable cards and boards.
- Basic and clean UI/UX.
- Allows collabrating by inviting your friends.
For sure, we know that there are way better applications doing what Inventum offers for years, and probably doing it way better and consistent. But we want this project to be in a trend where it is always improving so that maybe one day it will get there eventually.
Here are the list of the tech we used for building Inventum;
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
Before starting anything you may want to update your npm version.
- npm
npm install npm@latest -g
if you have docker installed, you can use the docker-compose file to run the docker containers. I would recommend using this method if you just want to see how the application works.
docker-compose build
docker-compose up- Clone the repo
git clone https://github.com/CGRDMZ/Inventum.git
- Change directory to the project folder
cd frontend - Install NPM packages
npm install
- Start the development server for react
npm start
- Change directory to the project folder
cd backend - Run the development server for dotnet core
dotnet watch run --project ./src/WebApi/WebApi.csproj --development
For the database you can either run a postgresql server on your local machine (install from here) or use the docker-compose.db-only.yml file to run a postgresql server on your local machine.
Basically, after downloading docker, use the commands below to build an image and run the container.
docker-compose -f docker-compose.db-only.yml build
docker-compose -f docker-compose.db-only.yml up(to be updated...)
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- 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
Distributed under the MIT License. See LICENSE.txt for more information.
(to be updated...)