contributing

tegcommerce is an open source e-commerce platform. everyone is welcome and even encouraged to contribute with their own improvements

tegcommerce is written mostly in javascript com reactjs and nodejs, html and css

there are many ways to contribute to the tegcommerce project!

if you wish to contribute within github, you should ideally be familiar with git, the source code management system that tegcommerce uses, with the official repository being hosted on github:

  • you can learn more about git here: http://try.github.io/ (there are many tutorials available on the Web)
  • you can get help on github here: https://help.github.com/
  • windows users can get a nice interface for git by installing tortoisegit: https://tortoisegit.org/

contributors should follow the following process:

  1. create your github account, if you do not have one already
  2. fork the tegcommerce project to your github account
  3. clone your fork to your local machine
  4. create a branch in your local clone for your changes
  5. change the files in your branch
  6. push your changed branch to your fork in your github account
  7. create a pull request for your changes on the tegcommerce project
  8. wait for one of the core developers either to include your change in the codebase, or to comment on possible improvements you should make to your code

that’s it: you have contributed to this open source project! congratulations!

if you don’t feel comfortable forking the project or using git, you can also either:

  • edit a file directly within github: browse to the target file, click the “edit” button, make your changes in the editor then click on “propose file change”. github will automatically create a new fork and branch on your own github account, then suggest to create a pull request to tegcommerce. once the pull request is submitted, you just have to wait for a core developer to answer you

remember if: contributions are always welcome, no matter how large or small

thank you for your help in making tegcommerce even better!

requirement

  • git
  • npm (> = 5.x)
  • nodejs (> = 8.x)
  • reactjs
  • redux
  • postgresql

installation

  1. make sure you have installed nodejs
  2. git clone git@github.com:tegcommerce/tegcommerce
  3. cd tegcommerce
  4. sudo npm install
  5. sudo npm start
  6. open http://localhost:3000/

application guide

simple free open everyone transparent decentralized collaborative inclusive minimalistic lean clear mean responsive progressive lifetime adaptable customizable light installable secure friendly intuitive integrated direct objective specialized focused basic clean automated cheap economic easy practical convenient innovate useful updated agile reasonable proportional meritocracy

community

any collaboration will be welcome!

brazilian community [pt]

international community [en]

are part of the community:

  • developers at all levels and in all areas
  • devops
  • designers
  • translators
  • event organizers
  • communicators and digital influencers
  • buyers and sellers
  • lawyers
  • others

ideal for those who want:

  • collaborate when and where you want
  • collaborate on open source project that positively impact the world
  • meet different people and participate in a plural and tolerant world-class team
  • learn, develop and excel personally and professionally

documentation

check out tegcommerce documentation

interact with the community

github
slack
telegram

license

by contributing to tegcommerce, you agree that your contributions will be licensed under its mit license.