Create Your First Project :: ActiveState Platform Documentation
Producing a reliable, customized project is a core function of the ActiveState Platform. This guide shows you how to create projects that include only the languages and artifacts (packages, bundles, patches, etc.) you need for the specific operating system(s) you are working on.
You can create projects using either the web interface or the State Tool CLI.
Create a Project via Web Interface
To create a new project from scratch using the web interface:
- Sign in to your ActiveState Platform account.
- Go to your organization’s Dashboard tab.
- Click the New Project button.
- Select the organization you want to create the project in.
- Select a language and version for your project.
- Choose one or more operating systems from the list provided. The option to select more than one operating system is restricted to paid tiers.
- If you are using Linux, be sure to choose a compatible
glibcfor your operating system.
- If you are using Linux, be sure to choose a compatible
- Choose your project access setting. Only paid tiers can make projects Private.
- Enter a unique project name or use the default name provided. The project name will act as its default URL.
- Choose to add packages now by clicking Add Packages, or click Finish and Install to move straight to downloading your project. If you add packages now:
- Search for individual packages and versions required for your project by entering the name of the package or bundle you need and clicking Add.
- Import packages from a file by clicking the link on the right. For more information on specifying your project requirements using a file, see Import and manage requirements.
- Click Close to return to your Project page with a notice to save your changes.
- If you made changes, click Save to commit your selection(s) to your project and begin the build process.
- Wait for the project to build. Build status can be seen from the Deploy tab.
- To use the project, go to the Overview tab of your project and follow the instructions to install and use your runtime.
After installing the State Tool, you can create a new ActiveState project directly from your command line by running:
state init <orgname>/<projectname> --language <language@version>
For example state init myOrg/python3.10 --language python@3.10
Your new project will automatically sync with your Platform account.
To access private projects in an organization, the State Tool must be authenticated against the ActiveState Platform by entering state auth and following the prompts.
Create a Project from an SBOM
This feature is for paid customers and is available upon request. Contact support to request this feature at support@activestate.com.
A software bill of materials (SBOM) declares the inventory of components used to build a software artifact, including any open source and proprietary software components. An SBOM allows development teams to make sure open-source and third-party software components are up to date and respond quickly to new vulnerabilities. Buyers and other stakeholders can use an SBOM to perform vulnerability or license analysis, which can be used to evaluate and manage risk in a product.
ActiveState projects can be created from a compatible SBOM. SBOMs can be generated by ActiveState or through third-party services like Snyk, Trivy, Syft, and others.
Create a project from an SBOM using the web UI
- Confirm you have an SBOM of a supported file type. See supported formats.
- Sign in to the ActiveState Platform.
- At the top of the page, select the organization where the new project should be created.
- Click Upload SBOM.
- Click Select file to upload and select your file.
- Choose a name your project. By default, the file name of the ingested SBOM will be used as the project name.
- Select your project access setting (Public or Private project).
- Click Create project.
- Review your SBOM analysis. In this read-only mode, you can view the full list of components and vulnerabilities in your project.
- If you encounter solver errors, you can select “Set all to auto” and make adjustments later in the Configuration tab.
- Missing packages will appear in Unavailable Packages.
- To make the project editable, click Fix Vulnerabilities and then Convert to Runtime.
Import a Project from GitHub
You can import the dependencies needed for your existing GitHub project directly from a requirements file in the root folder of your GitHub repository. At this time, we only support Python, Perl, and Ruby projects.
This feature is only available to users who have linked a GitHub SSO to their ActiveState account. For more information, see create an account.
To import an existing GitHub project:
- Sign in to the ActiveState Platform.
- Go to your organization’s Dashboard tab.
- Click the +New Project button.
- Click the Scan a Repository button.
- Select your repository by using the search bar, clicking the correct repo from the list shown, or entering the repository URL in the field provided.
- Click Scan Repo.
- After receiving an “Import Status Success” message, click Continue to continue building your runtime.
- Select a language version, operating system, and set the visibility of your project to Public or Private.
- Click Create Project to return to your project Configuration page.
If your GitHub integration does not succeed, verify that your requirements file name in the root folder of your repo matches one of the following:
- Python projects:
requirements.txt,Pipfile.lock,pyproject.toml,poetry.lock, or anyPipfile - Perl projects:
META.jsonor anycpanfile - Ruby projects:
Gemfile.lock
Next Steps
After creating your project:
- Deploy it locally - Get your project running on your machine
- Manage packages - Add and update dependencies
- Share with others - Collaborate with team members
- Move or organize projects - Manage multiple projects