Start a project

To work on SourceLair you will need to start a project to store, edit and run your code.

Starting your project

You can start a new project either from the Quickstart screen or from your current project’s workspace.

Quickstart

The Quickstart screen is the first thing you see after signing up and it is visible only when you have no projects available. To create a new project from that screen click on the Start a project button.

Project workspace

When working on a project on SourceLair you can start a new one in the following two ways:

1. running the Project: Start new Project command in the Command Palette
2. clicking on the plus (+) button , in the sidebar to start a new project.
   
   

Steps to create your project

1. Start from scratch or clone a repo

First you have to choose whether you will start a new project from scratch or clone a Git repo by clicking on the respective button of the modal window that appears first.

Cloning a repo

If you are starting a project by cloning a Git repo:

1. enter the URL of your repo or click on the GitHub repo of your choice (if you have connected your account with GitHub)
2. click on the Clone button

ATTENTION: Remember to put your public key to the Git server you are cloning from. This step is not needed if you have connected your account with GitHub and you are cloning a GitHub repo.

2. Configure your project

The next step is to configure your project according to your needs. You can create:

• a Basic project (this is the default way), which comes with some sweet defaults
• or a Custom project, which is tailored exactly arround your needs.

Configuring a Basic project

To configure a Basic project follow these 3 steps

1. give a name to your project (only alpanumeric characters and dashes are allowed)
2. choose your preset
3. click on the Create button

Configuring a custom project

To configure a Custom project follow these 5 steps

1. click on the Custom tab, next to Basic on the top
2. give a name to your project (only alpanumeric characters and dashes are allowed)
3. choose the language, language version and framework of your choice and whether you would like a Heroku optimized project
4. optionally add a database to your project
5. click on the Create button

For any additional details about projects and their capabilities check out the available stacks and databases. If you need further assistance, do not hesitate and drop us a line at [email protected].