Skip to content

Commit 2cabeb0

Browse files
Eliran-TurgemanEliran-Turgeman
committed
adding docs
1 parent 4811e45 commit 2cabeb0

5 files changed

+226
-1
lines changed

‎README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
# A
1+
# Skill Issues Killer Projects Plaform
2+
3+
Welcome to our projects platform! This platform is designed to help you build and test API projects through a series of guided exercises. This README will guide you through the installation process and provide links to additional guides to help you get started.
4+
5+
## Installation
6+
7+
To get started, you need to install the platform on your machine. Follow these steps:
8+
9+
1. **Go to the Repository Releases on GitHub**: Navigate to the [releases page](https://github.com/sissues/cli/releases) on our GitHub repository.
10+
2. **Download the Correct Asset**: Find the latest release and download the asset appropriate for your operating system. Here's a picture to help you locate the releases:
11+
12+
![GitHub Releases](./docs/releases-page-screenshot.png)
13+
14+
**_For Mac / Linux_** - Download the first asset named `sissues`.
15+
16+
**_For Windows_** - Download the second asset named `sissues.exe`
17+
18+
3. **Run the platform**: Click on the downloaded asset, and it should open up the following CLI
19+
20+
![](./docs/cli-screenshot.png)
21+
22+
## Getting Started
23+
24+
Once you have installed the platform, you can start working on your API projects. Here are some guides to help you get started:
25+
1. [Getting Started with Your API Project](https://github.com/sissues/cli/blob/main/docs/getting_started.md)
26+
2. [Getting Started with Docker for API Projects](https://github.com/sissues/cli/blob/main/docs/getting_start_with_docker.md)
27+
28+
## Additional Resources
29+
30+
- **Community Support**: If you have any questions or need help, don't hesitate to reach out to by [opening an issue](https://github.com/sissues/cli/issues).
31+
- **Documentation**: Refer to the platform's documentation for detailed information on features and usage.
32+
33+
## Final Tips
34+
35+
- **Stay Positive**: Learning new skills can be challenging, but stay positive and persistent. You can do this!
36+
- **Practice Makes Perfect**: The more you practice, the better you'll become. Keep working on the exercises and refining your skills.
37+
- **Use Resources**: Make use of the resources available to you, including documentation, forums, and community support.
38+
39+
We’re excited to see what you create with our platform. Happy coding!

‎docs/cli-screenshot.png

89.6 KB
Loading

‎docs/getting_started.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Getting Started with Your API Project
2+
3+
Welcome to our API exercise platform! We're excited to have you here and ready to guide you through getting started with your project. This guide will help you understand the platform, set up your project, and work towards a working solution. Don't worry—you're in good hands!
4+
5+
### Step 1: Understanding the Platform
6+
7+
Our platform is designed to help you build API projects through a series of exercises. Each exercise will simulate real-world scenarios, helping you develop practical skills. Here’s what you need to know:
8+
9+
- **Exercises**: These are mini-projects with multiple steps. Each step is designed to build on the previous one, gradually increasing in complexity.
10+
- **Automatic Test Suites**: Each exercise comes with a set of automated tests. These tests will check your code and ensure it meets the requirements.
11+
- **Manual Code Reviews**: For a fee, you can get your code reviewed manually. This is optional but can provide valuable feedback.
12+
13+
### Step 2: Setting Up Your Environment
14+
15+
Before you start coding, you need to set up your development environment. Follow these steps:
16+
17+
1. Refer to the [Getting started with docker guide](https://github.com/sissues/cli/blob/main/docs/getting_start_with_docker.md) to learn how to install Docker, and tweak the dockerfile template to your programming language and API framework.
18+
19+
### Step 3: Starting Your Project
20+
21+
1. **Pick an Exercise**: Browse the available exercises. Choose one that interests you and click on it to view the details.
22+
2. **Initialize the Project**: Click the "Start Project" button. This will initialize the project template for you, setting up everything you need to get started.
23+
3. **Review the Dockerfile Template**: The initialized project will include a Dockerfile template. For guidance on how to modify it, refer to our [Getting started with docker guide](https://github.com/sissues/cli/blob/main/docs/getting_start_with_docker.md).
24+
25+
### Step 4: Writing Your Code
26+
27+
With your project set up, you can start writing your code. Here are some tips to help you get started:
28+
29+
1. **Follow the Instructions**: Each exercise comes with detailed instructions. Follow them carefully to ensure you meet the requirements.
30+
2. **Test Frequently**: Use the "Run Tests" button to run the provided tests frequently. This will help you catch issues early and ensure your code meets the requirements.
31+
3. **Ask for Help**: If you get stuck, don't hesitate to ask questions by [opening an issue](https://github.com/sissues/cli/issues). We're here to help!
32+
33+
### Step 5: Running Tests
34+
35+
Running tests is crucial to ensure your code works as expected. Here’s how you can run the tests on our platform:
36+
37+
1. **Click "Run Tests"**: Once you’ve written some code, and modified your Dockerfile correctly, click the "Run Tests" button. The platform will automatically build your Docker image and run the tests for you.
38+
2. **Check the Results**: Review the test results and fix any issues. Repeat this process until all tests pass.
39+
40+
### Final Tips
41+
42+
- **Stay Positive**: Learning new skills can be challenging, but stay positive and persistent. You can do this!
43+
- **Practice Makes Perfect**: The more you practice, the better you'll become. Keep working on the exercises and refining your skills.
44+
- **Use Resources**: Make use of the resources available to you, including documentation, forums, and community support.
45+
46+
Remember, you're not alone on this journey. We're here to support you every step of the way. Happy coding!

‎docs/getting_started_with_docker.md

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
## Getting Started with Docker for API Projects
2+
3+
Welcome to our API exercise platform! We're here to help you get started with Docker, understand the provided Dockerfile template, and modify it to suit your chosen language and framework. Don't worry—setting up a working Dockerfile is easier than it seems!
4+
5+
### Step 1: Installing Docker
6+
7+
Before you can use Docker, you need to install it on your machine. Follow these simple instructions for your operating system:
8+
9+
**For Windows:**
10+
11+
1. Download Docker Desktop from [Docker's official website](https://www.docker.com/products/docker-desktop).
12+
2. Run the installer and follow the on-screen instructions.
13+
3. After installation, Docker Desktop should start automatically. If not, open it from the Start menu.
14+
15+
**For macOS:**
16+
17+
1. Download Docker Desktop from [Docker's official website](https://www.docker.com/products/docker-desktop).
18+
2. Open the downloaded `.dmg` file and drag Docker to your Applications folder.
19+
3. Open Docker from your Applications folder.
20+
21+
**For Linux:**
22+
23+
1. Follow the instructions on the [Docker installation page](https://docs.docker.com/engine/install/#server).
24+
2. Make sure to follow any additional steps for your specific distribution.
25+
26+
### Step 2: Understanding the Dockerfile Template
27+
28+
Here's the Dockerfile template you will be working with:
29+
30+
```dockerfile
31+
# Use an official runtime as a parent image
32+
FROM <runtime_image>
33+
34+
# Set the working directory in the container
35+
WORKDIR /{project_name}
36+
37+
# Install any dependencies
38+
RUN <install_command>
39+
40+
# Copy the current directory contents into the container at /app
41+
COPY src/ .
42+
43+
# Make port 5000 available to the world outside this container
44+
EXPOSE 5000
45+
46+
# Run the application
47+
CMD [ "<start_command>" ]
48+
```
49+
50+
### Step 3: Modifying the Dockerfile for Your Project
51+
You can choose any programming language and API framework for your project. The key is to write the Dockerfile correctly, and we believe you can do it! Here are some examples for popular languages and frameworks to help you get started. Feel free to Google for more examples specific to your setup.
52+
53+
54+
**Example: Python (Flask)**
55+
56+
```dockerfile
57+
# Use an official Python runtime as a parent image
58+
FROM python:3.8-slim
59+
60+
# Set the working directory in the container
61+
# The correct dir here will be injected automatically whenever you click 'Start Project'
62+
WORKDIR /library_management_system
63+
64+
# Install any dependencies
65+
RUN pip install flask
66+
67+
# Copy the current directory contents into the container at /app
68+
COPY src/ .
69+
70+
# Make port 5000 available to the world outside this container
71+
EXPOSE 5000
72+
73+
# Run the application
74+
CMD [ "python", "app.py" ]
75+
```
76+
77+
**Example: Node.js (Express)**
78+
79+
```dockerfile
80+
# Use an official Node.js runtime as a parent image
81+
FROM node:14
82+
83+
# Set the working directory in the container
84+
# The correct dir here will be injected automatically whenever you click 'Start Project'
85+
WORKDIR /library_management_system
86+
87+
# Install any dependencies
88+
COPY package*.json ./
89+
RUN npm install
90+
91+
# Copy the current directory contents into the container at /app
92+
COPY src/ .
93+
94+
# Make port 5000 available to the world outside this container
95+
EXPOSE 5000
96+
97+
# Run the application
98+
CMD [ "node", "app.js" ]
99+
```
100+
101+
**Example: Java (Spring Boot)**
102+
103+
```dockerfile
104+
# Use an official OpenJDK runtime as a parent image
105+
FROM openjdk:11
106+
107+
# Set the working directory in the container
108+
# The correct dir here will be injected automatically whenever you click 'Start Project'
109+
WORKDIR /library_management_system
110+
111+
# Install any dependencies (Maven in this case)
112+
RUN apt-get update && apt-get install -y maven
113+
114+
# Copy the current directory contents into the container at /app
115+
COPY src/ .
116+
117+
# Build the application
118+
RUN mvn clean package
119+
120+
# Make port 5000 available to the world outside this container
121+
EXPOSE 5000
122+
123+
# Run the application
124+
CMD [ "java", "-jar", "target/myapp.jar" ]
125+
```
126+
127+
128+
## Step 4: Customizing for Your Project
129+
* Choose the base image: Look for an official image that suits your programming language and framework. You can find these on Docker Hub.
130+
* Set the working directory: This is already set for you at /project_name, so no changes needed here!
131+
* Install dependencies: Use the appropriate command to install your project's dependencies.
132+
* Copy your project files: Adjust the COPY command if your project structure differs.
133+
* Expose the correct port: Ensure the port you expose matches the port your application runs on.
134+
* Run your application: Modify the CMD to start your application correctly.
135+
136+
## Final Tips
137+
* Google is your friend: Search for Dockerfile examples specific to your language and framework.
138+
* Look at official documentation: Many frameworks provide Dockerfile examples and best practices.
139+
* Ask for help: If you get stuck, don't hesitate to ask questions in our community or look for solutions on forums like Stack Overflow.
140+
141+
Remember, you can do this! Setting up a Dockerfile is a great skill to have, and with a bit of practice, it will become second nature. Happy coding!

‎docs/releases-page-screenshot.png

36.9 KB
Loading

0 commit comments

Comments
 (0)