To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!
- Create or upload files
- Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin https://gitlab.com/lucasKO2810/saleor.git
git branch -M main
git push -uf origin main
- Invite team members and collaborators
- Create a new merge request
- Automatically close issues from merge requests
- Enable merge request approvals
- Automatically merge when pipeline succeeds
Use the built-in continuous integration in GitLab.
- Get started with GitLab CI/CD
- Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
- Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
- Use pull-based deployments for improved Kubernetes management
- Set up protected environments
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
SPEC - Saleor Powered E-Commerce
This is an ECommerce based on Saleor API.
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
Your first step is to setup Saleor itself.
To run Saleor on your local machine you need to follow these instructions:
- You need to have installed Docker and Docker Compose and then build an image of the Saleor project:
**cd saleor-platform
docker-compose build**You need also to make sure, that <path_to_working_directory>/saleor-platform is in the list of shared directories in Docker(Settings -> Shared Drives or Preferences -> Resources -> File sharing) and you have dedicated at least 5 GB of memory(Settings -> Advanced or Preferences -> Resources -> Advanced)
- Apply all migrations
docker-compose run --rm api python3 [manage.py](http://manage.py/) migrate- Collect static files
docker-compose run --rm api python3 manage.py collectstatic --noinput- Populate the database with example data and create the admin user:
docker-compose run --rm api python3 manage.py populatedb --createsuperuser Note💡: populatedb is optional and is advised if you need some test data when developing
- Run the app:
docker-compose up- Alternative( if you need only api and dashboard):
docker-compose up api workerAfter you had your Saleor set up you can start testing if you did all correct by going on http://localhost:8000. Here you can find all three components of Saleor service:
- Dashboard
- Storefront( basically just a a front-end template )
You will have later an opportunity to bind your own front-end
- GraphQL Playground(DEBUG=True)
💡 In my opinion can be a very good of a tool when testing your requests onto the back-end and even just writing your requests
All you need to do when launching frontend is following:
- Install all dependencies(if you are in spec folder):
cd saleor-platform/frontend
npm install- Run the application:
npm run devThen you can easily access the frontend application and develop fast.
There is a shell script start_up.sh **in spec folder which will do all the launching for you. Thus you need just to launch this script:
sudo sh start_up.shIf you want to shut down the application there is another shell script:
sudo sh down.shThat's it. You now can launch the application in all ways you may need 😁
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.