Projects
Table of Contents
About The Project
This microservice is a part of a bigger project - ProgrammersOnlyApp. Our project’s sole purpose is to connect people like you - creative github users. Users with too many ideas and not enough people to execute them. Users with a need for open-source contributions. If you are a programmer, this is a place for you.
On the other hand, this microservice is for storing your projects, ideas and everything that is connected to that. That way people you are looking for will be able to find you themselves!
Built With
Handled with
Getting Started
Prerequisites
- npm
npm install npm@latest -g
Installation
- Clone the repo
git clone https://github.com/Programmers-Only-Group/projects.git
- Install NPM packages
- Setup database App requires mongodb to run. Open file '.env.example' and add variable 'MONGODB_URL' with your database address. After that rename file to '.env'. If you don't have it installed yet check this [address] (https://docs.mongodb.com/manual/installation/).
Usage
Build
Run
Test
API
Roadmap
Phase 1 - Base Setup:
- Base test setup
- Base backend setup
- Base db structure
- Add, Edit and Remove project from portfolio
- Synchronize projects list with GitHub
Phase 2 - Visualization:
- Get project, Get list of projects
- Base UI mockups
- Mark project as open for contributions
Phase 3 - Rating:
- Synchronize projects follows with GitHub
- Allow other users to follow other project
- Add, Edit, Remove list of followed projects
Phase 4 - Feed:
- Generate lists of most popular projects
- Generate lists of latest projects followed by user that received contribution
See the open issues for a list of proposed features (and known issues).
Contributing
- Clone 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
License
Distributed under the GPL-3.0 License.