Open alcpereira opened 1 month ago
The current README.md doesn't mention anything regarding how to start the project. It misses some important parts:
README.md
npm install
npm run dev
npm start
npm run build
20.6
--env-file
tsx
.nvmrc
.env
server.ts
It is important that you try to understand what each step do, feel free to ask questions if you have some doubts.
This issue is complementary to #14 as it's more oriented regarding the setup part.
Description
The current
README.md
doesn't mention anything regarding how to start the project. It misses some important parts:npm install
andnpm run dev
, information thatnpm start
refers to a production command (afternpm run build
for example)20.6
) to leverage the--env-file
functionality that we are using throughtsx
.nvmrc
file.env
file (this will be updated with the issue #6 with more detailed instructions regarding how to setup the database)server.ts
to see the right Express port)It is important that you try to understand what each step do, feel free to ask questions if you have some doubts.
This issue is complementary to #14 as it's more oriented regarding the setup part.
ACs
README.md
with instructions on how to get started