Project
Create and manage CodeMash projects.
When you first log in to the dashboard, you can easily create a new project by giving it a name and setting its location. You can also customize other project settings and preferences as needed.
Once your project is created, you can start enabling cloud services one by one. CodeMash offers many services, including authentication, database management, payments, file storage, push or email notifications, and more. You can easily add these services to your project with just a few clicks and start using them immediately.
Regarding your license you own on CodeMash, you can create from one to many projects on CodeMash. Each project can represent a mobile, web, IoT, or wearable app.
The first thing to do before you start using CodeMash services is to create a new project.
When you create a new project, you are typically asked to provide the project name and location.
Project Name - The project name is used to identify the project among your team. You can also use this in Email or Push notifications with the token @Model.ProjectName
Region - Where project servers will be located. Once the project has been created, you can add additional services, such as a database or file storage. To maximize your app's performance, it's important to locate these services near the project location. This will minimize the server round trip time, the time it takes for a request to be sent from the client to the server, and for a response to be sent back. The shorter the server round trip time, the faster the project will run and the better the user experience.
Project Settings
Go to the Project -> Settings sidebar menu to find the project settings. Each setting is described in the table below. You can navigate to the project settings and change them one by one.
Please take a look at the explanation in the table below:
| Section | Setting | Description |
|---|---|---|
Defaults | ||
Project ID | Project ID plays a massive role in each CodeMash API call. That's how we can identify you among other CodeMash projects. See more. | |
Secret key | When you do scripting and use CodeMash CLI to generate or restore a project from a snapshot, you can give project admin rights to do anything with your project. Regenerate the secret key afterward and never ever use it in any client (web, IoT, mobile, wearables). | |
Project name | Friendly project name can be used from templates as token @Model.ProjectName | |
Project slugified name | Url friendly project name. | |
Logo | Project logo. Can be used in templates with the token @Model.Logo | |
Project description | Project description can be used in templates with @Model.ProjectDescriotion | |
Project Url | Project marketing website. | |
Allowed origins | If you calling CodeMash API from the web app (from a browser), you need to set your app URL(s) in the allowed origins section. More about CORS. | |
Languages | ||
Default language | Default project language. Emails, push notifications, and data can be translatable. If culture is not set explicitly, the output of the API request will be in the default language. | |
Supported languages | Set your project-supported languages and translate your data (text input marked as translatable), emails, and push notifications. This can be useful if you want to make your project available in multiple languages and provide a better user experience for people who speak those languages. | |
Regions | ||
Project region | The central project region where API is located. Other services should be placed in the central project region to maximize performance. | |
Time zone | Set the time zone to know how we can send notifications in other zones respectively. | |
User zones | Change pricing by zone respectively. See the Payments module. | |
Custom Tokens | Key/Value | Custom key-value pairs. So you can set custom environment variables here and access them from templates, code, or CodeMash Cloud UI. |
Billing | Billing information. See the section "Billing Information" below. |
Billing Information
In CodeMash, you can set your project's billing information, and CodeMash can charge your clients on behalf of your organization.
You can choose to set a fixed price for the project or a percentage of the cost of the services that have been used. Additionally, you can enter your billing information to enable automatic invoicing, making tracking and managing your project's costs easier.
Finally, you can enter a payment method so that your clients can be charged automatically, making it easy and convenient to manage the billing for your project.
Customer Charge
In CodeMash, there are two types of charges that you can apply to your clients. The first is a fixed amount, which is a set price that you charge your client in addition to the cost of any resources that have been used. For example, if your client stored files for $5 and you charged a fixed amount of $10, the total cost would be $15.
The second type of charge is a dynamic amount, which is based on the usage of resources by the client. For example, if your client stored files for $5 and you charged a percentage of 10%, the total cost would be $5.50. This charge allows you to adjust the price based on the number of resources used, providing more flexibility and control over your project's costs.
API Reference
Please see our API documentation to learn more about leveraging project and project settings using CodeMash's API, CLI, or one of our supported SDKs.
Our documentation provides detailed information about the different methods and options for working with projects and project settings in CodeMash. Whether you're a developer looking to integrate CodeMash into your own applications or a user who wants to learn more about the features and capabilities of our platform, our API documentation is a great place to start.
Last updated
